Package dev.galasa.zosliberty

Interface IZosLibertyServerXml

public interface IZosLibertyServerXml

Represents the server.xml configuration file in a zOS Liberty Server.

NOTE: The IZosLibertyServerXml object may not be the same as the content of the server.xml on the zOS UNIX file system.
Use the loadFromFileSystem() method to update the object with the content of the server.xml on the zOS UNIX file system.
Use the store() method to update the the server.xml on the zOS UNIX file system with with the content of the object.

Method Summary

Modifier and Type	Method	Description
void	addCommentsBefore(Element element, String... comments)	Add one or more XML comment before the supplied XML element
Element	addCompoundElement(String elementName, Map<String,String> elementAttributes, IZosLibertyServerXmlElementList subElements)	Add a compound XML element to the Liberty server.xml Document object
Element	addCompoundElementToParent(Element parent, String elementName, Map<String,String> elementAttributes, IZosLibertyServerXmlElementList subElements)	Add a compound XML element as a child to supplied XML element in the Liberty server.xml Document object
Element	addElement(String elementName, Map<String,String> elementAttributes)	Add a simple XML element to the Liberty server.xml Document object
Element	addElementToParent(Element parent, String elementName, Map<String,String> elementAttributes)	Add a simple XML element as a child to supplied XML element in the Liberty server.xml Document object
Element	addTextContextElement(Element parent, String elementName, String elementText)	Add a text context XML element as a child to supplied XML element in the Liberty server.xml Document object
Document	getAsDocument()	Get the Liberty server.xml object as a Document
String	getAsString()	Get the Liberty server.xml object as a String
IZosUNIXFile	getAsZosUNIXFile()	Get the Liberty server.xml as a IZosUNIXFile
List<Element>	getElements(String elementName)	Get an list of XML elements from the Liberty server.xml Document object. N.B.
List<Element>	getElementsById(String elementName, String id)	Get an list of XML elements from the Liberty server.xml Document object. N.B.
void	loadFromFileSystem()	Update the content of the IZosLibertyServerXml with the content of the server.xml file from the zOS UNIX file system
Element	modifyElementAttributes(Element element, Map<String,String> attributes)	Add or replace attributes in supplied XML element.
IZosLibertyServerXmlElementList	newElementList()	Create an IZosLibertyServerXmlElementList
Element	removeElementAttribute(Element element, String attribute)	Remove an attribute from supplied XML element
void	removeElements(String elementName)	Remove all XML elements with specified name from the Liberty server.xml Document object
void	removeElementsById(String elementName, String id)	Remove all XML elements with specified name and id from the Liberty server.xml Document object
void	removeTextContextElement(Element parent, String elementName, String elementText)	Remove a text context XML element in the Liberty server.xml Document object
void	saveToResultsArchive(String rasPath)	Store the content of the Liberty server.xml to the Results Archive Store
void	setFromDocument(Document serverXml)	Replace the Liberty server.xml object from Document content
void	setFromString(String serverXml)	Replace the Liberty server.xml object from String content
void	setFromZosUNIXFile(IZosUNIXFile serverXml)	Replace the Liberty server.xml object from IZosUNIXFile content
void	store()	Create or replace the server.xml file on the zOS UNIX file system

Method Details

setFromDocument

void setFromDocument(Document serverXml)
              throws ZosLibertyServerException

Replace the Liberty server.xml object from Document content

Parameters:

serverXml - the server.xml content

Throws:

ZosLibertyServerException

setFromString

void setFromString(String serverXml)
            throws ZosLibertyServerException

Replace the Liberty server.xml object from String content

Parameters:

serverXml - the server.xml content

Throws:

ZosLibertyServerException

setFromZosUNIXFile

void setFromZosUNIXFile(IZosUNIXFile serverXml)
                 throws ZosLibertyServerException

Replace the Liberty server.xml object from IZosUNIXFile content

Parameters:

serverXml - the server.xml content

Throws:

ZosLibertyServerException

getAsDocument

Document getAsDocument()
                throws ZosLibertyServerException

Get the Liberty server.xml object as a Document

Returns:

the content of the Liberty server.xml

Throws:

ZosLibertyServerException

getAsString

String getAsString()
            throws ZosLibertyServerException

Get the Liberty server.xml object as a String

Returns:

the content of the Liberty server.xml

Throws:

ZosLibertyServerException

getAsZosUNIXFile

IZosUNIXFile getAsZosUNIXFile()
                       throws ZosLibertyServerException

Get the Liberty server.xml as a IZosUNIXFile

Returns:

the Liberty server.xml file

Throws:

ZosLibertyServerException

store

void store()
    throws ZosLibertyServerException

Create or replace the server.xml file on the zOS UNIX file system

Throws:

ZosLibertyServerException

loadFromFileSystem

void loadFromFileSystem()
                 throws ZosLibertyServerException

Update the content of the IZosLibertyServerXml with the content of the server.xml file from the zOS UNIX file system

Throws:

ZosLibertyServerException

saveToResultsArchive

void saveToResultsArchive(String rasPath)
                   throws ZosLibertyServerException

Store the content of the Liberty server.xml to the Results Archive Store

Parameters:

rasPath - path in Results Archive

Throws:

ZosLibertyServerException

getElements

List<Element> getElements(String elementName)
                   throws ZosLibertyServerException

Get an list of XML elements from the Liberty server.xml Document object.
N.B. a list is returned because there may be more than on instance of the named XML element in the Document

Parameters:

elementName - the XML element name

Throws:

ZosLibertyServerException

getElementsById

List<Element> getElementsById(String elementName,
 String id)
                       throws ZosLibertyServerException

Get an list of XML elements from the Liberty server.xml Document object.
N.B. a list is returned because there may be more than on instance of the named XML element in the Document

Parameters:

elementName - the XML element name

id - the id of the named XML element

Throws:

ZosLibertyServerException

addElement

Element addElement(String elementName,
 Map<String,String> elementAttributes)
            throws ZosLibertyServerException

Add a simple XML element to the Liberty server.xml Document object

Parameters:

elementName - the XML element name

elementAttributes - the XML element attributes

Returns:

the newly added XML element

Throws:

ZosLibertyServerException

addElementToParent

Element addElementToParent(Element parent,
 String elementName,
 Map<String,String> elementAttributes)
                    throws ZosLibertyServerException

Add a simple XML element as a child to supplied XML element in the Liberty server.xml Document object

Parameters:

parent - the parent XML element

elementName - the XML element name

elementAttributes - the XML element attributes

Returns:

the newly added XML element

Throws:

ZosLibertyServerException

addCompoundElement

Element addCompoundElement(String elementName,
 Map<String,String> elementAttributes,
 IZosLibertyServerXmlElementList subElements)
                    throws ZosLibertyServerException

Add a compound XML element to the Liberty server.xml Document object

Parameters:

elementName - the XML element name

elementAttributes - the XML element attributes

subElements - an IZosLibertyServerXmlElementList of sub XML elements

Returns:

the newly added XML element

Throws:

ZosLibertyServerException

addCompoundElementToParent

Element addCompoundElementToParent(Element parent,
 String elementName,
 Map<String,String> elementAttributes,
 IZosLibertyServerXmlElementList subElements)
                            throws ZosLibertyServerException

Add a compound XML element as a child to supplied XML element in the Liberty server.xml Document object

Parameters:

parent - the parent XML element

elementName - the XML element name

elementAttributes - the XML element attributes

subElements - an IZosLibertyServerXmlElementList of sub XML elements

Returns:

the newly added XML element

Throws:

ZosLibertyServerException

modifyElementAttributes

Element modifyElementAttributes(Element element,
 Map<String,String> attributes)

Add or replace attributes in supplied XML element. If any of the supplied attributes match an existing attribute, the value will be replaced otherwise the supplied attribute will be added.

Parameters:

element - the XML element

attributes - the new XML element attributes

Returns:

the modified XML element

addTextContextElement

Element addTextContextElement(Element parent,
 String elementName,
 String elementText)
                       throws ZosLibertyServerException

Add a text context XML element as a child to supplied XML element in the Liberty server.xml Document object

Parameters:

parent - the parent XML element

elementName - the XML element name

elementText - the XML element text

Returns:

the newly added XML element

Throws:

ZosLibertyServerException

addCommentsBefore

void addCommentsBefore(Element element,
 String... comments)
                throws ZosLibertyServerException

Add one or more XML comment before the supplied XML element

Parameters:

element - the XML element

comments - the comments to add

Throws:

ZosLibertyServerException

removeElements

void removeElements(String elementName)
             throws ZosLibertyServerException

Remove all XML elements with specified name from the Liberty server.xml Document object

Parameters:

elementName - the XML element name

Throws:

ZosLibertyServerException

removeElementsById

void removeElementsById(String elementName,
 String id)
                 throws ZosLibertyServerException

Remove all XML elements with specified name and id from the Liberty server.xml Document object

Parameters:

elementName - the XML element name

id - the XML element id

Throws:

ZosLibertyServerException

removeElementAttribute

Element removeElementAttribute(Element element,
 String attribute)

Remove an attribute from supplied XML element

Parameters:

element - the XML element

attribute - the attribute to remove

Returns:

the modified XML element

removeTextContextElement

void removeTextContextElement(Element parent,
 String elementName,
 String elementText)

Remove a text context XML element in the Liberty server.xml Document object

Parameters:

parent - the parent XML element

elementName - the XML element name

elementText - the XML element text

Throws:

ZosLibertyServerException

newElementList

IZosLibertyServerXmlElementList newElementList()

Create an IZosLibertyServerXmlElementList

Returns:

IZosLibertyServerXmlElementList