Package dev.galasa.zosliberty

Interface IZosLibertyServer

public interface IZosLibertyServer

Represents a zOS Liberty server

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IZosLibertyServer.ApplicationType

Method Summary

Modifier and Type	Method	Description
void	addFeature(String feature)	Convenience method to add a feature to the Liberty server server.xml
void	build()	Builds the the Liberty server on the zOS UNIX file system from any objects that have been created such as the server.xml
void	checkpointLogs()	Convenience method to checkpoint the known Liberty server logs, i.e.
void	clearLogs()	Clear the contents of the Liberty servers logs directory
int	create()	Create a Liberty server using the server create command
void	delete()	Delete the Liberty server files and directories
void	deployApplication(Class<?> testClass, String path, String targetLocation, IZosLibertyServer.ApplicationType type, String name, String contextRoot)	Deploy an application to the Liberty server.
void	deployApplicationToDropins(Class<?> testClass, String path)	Deploy an application to the Liberty server dropins directory.
IZosUNIXFile	getDropinsDir()	Get the Liberty server dropins directory
IZosUNIXFile	getJavaHome()	Get the JAVA_HOME value for this Liberty server
IZosUNIXFile	getKeystoreFile()	Returns the keystore file for this Liberty server
IZosLibertyServerLogs	getLogs()	Get the contents of the Liberty servers logs directory
IZosUNIXFile	getLogsDirectory()	Get the Liberty server logs directory
IZosUNIXFile	getServerConfigDir()	Returns the Liberty Server Configuration Directory ${server.config.app.dir} as a IZosUNIXFile object
String	getServerName()	Returns the Liberty Server Name
IZosUNIXFile	getServerOutputDir()	Returns the Liberty Server Output Directory ${server.output.dir} as a IZosUNIXFile object
IZosLibertyServerXml	getServerXml()	Get the server.xml object for this Liberty server
IZosUNIXFile	getSharedAppDir()	Returns the Liberty Shared Application Directory ${shared.app.dir} as a IZosUNIXFile object
IZosUNIXFile	getSharedConfigDir()	Returns the Liberty Shared Configuration Directory ${shared.config.dir} as a IZosUNIXFile object
IZosUNIXFile	getSharedResourcesDir()	Returns the Liberty Shared Resources Directory ${shared.resources.dir} as a IZosUNIXFile object
String	getVersion()	Returns the Liberty version
IZosUNIXFile	getWlpInstallDir()	Returns the Liberty Install Directory ${WLP_INSTALL_DIR} as a IZosUNIXFile object
IZosUNIXFile	getWlpOutputDir()	Returns the Liberty Output Directory ${WLP_OUTPUT_DIR} as a IZosUNIXFile object
IZosUNIXFile	getWlpUserDir()	Returns the Liberty User Directory ${WLP_USER_DIR} as a IZosUNIXFile object
IZosImage	getZosImage()	Get the zOS Image for this Liberty server
List<String>	listFeatures()	Convenience method to list the current features listed in the featureManager element in the Liberty server server.xml
IZosLibertyServerXml	loadServerXmlFromFileSystem()	Load the content of the Liberty server.xml from the file system into the internal IZosLibertyServerXml object
void	removeApplication(String name)	Remove an application from the Liberty server.
void	removeApplicationFromDropins(String fileName)	Remove an application from the Liberty server dropins directory.
void	removeFeature(String feature)	Convenience method remove a feature from the Liberty server server.xml
String	retrieveMessagesLog()	Get the current contents of the Liberty server messages.log as a String
String	retrieveMessagesLogSinceCheckpoint()	Get the current contents of the Liberty server messages.log as a String since the last checkpoint
String	retrieveTraceLog()	Get the current contents of the Liberty server trace.log as a String
String	retrieveTraceLogSinceCheckpoint()	Get the current contents of the Liberty server trace.log as a String since the last checkpoint
int	run()	Run the Liberty server as a zOS batch job
void	saveToResultsArchive()	Store the content of the Liberty server logs and configuration to the default location in the Results Archive Store
void	saveToResultsArchive(String rasPath)	Store the content of the Liberty server logs and configuration to the Results Archive Store
String	securityUtilityEncode(String password)	Use the Liberty securityUtility command to encode a password
IZosUNIXFile	securityUtilityGenerateKeystore(String password)	Use the Liberty securityUtility to create a new keyStore
void	setDefaultHttpEndpoint(String host, int httpPort, int httpsPort)	Convenience method to create or replace the defaultHttpEndpoint element in the Liberty server server.xml
void	setJavaHome(String javaHome)	Set the value of JAVA_HOME for this Liberty server
void	setServerName(String serverName)	Provides the Liberty Server Name
void	setServerXml(IZosLibertyServerXml serverXml)	Set the server.xml object for this Liberty server
void	setWlpInstallDir(String wlpInstallDir)	Provides the location of the Liberty Install Directory ${WLP_INSTALL_DIR}
void	setWlpOutputDir(String wlpOutputDir)	Provides the location of the Liberty Output Directory ${WLP_OUTPUT_DIR}
void	setWlpUserDir(String wlpUserDir)	Provides the location of the Liberty User Directory ${WLP_USER_DIR}
int	start()	Start the Liberty server using the server start command
int	status()	Get the Liberty sever status using the server status command
int	stop()	Stop the Liberty server
boolean	waitForApplicationStart(String name)	Wait for an application to start using the default timeout by looking for CWWKZ0001I message in messages.log.
boolean	waitForApplicationStart(String name, int timeout)	Wait for an application to start using the supplied timeout by looking for CWWKZ0001I message in messages.log.
boolean	waitForApplicationStop(String name)	Wait for an application to stop using the default timeout by looking for CWWKZ0009I message in messages.log.
boolean	waitForApplicationStop(String name, int timeout)	If the messages.log has not been check-pointed, the whole file will be searched.
int	waitForStart()	Wait for the Liberty server to start using the default timeout
int	waitForStart(int timeout)	Wait for the Liberty server to start using the supplied timeout
boolean	waitForStartMessage()	Wait for the Liberty server to issue the CWWKF0011I message to the messages.log using the default timeout
boolean	waitForStartMessage(int timeout)	Wait for the Liberty server to issue the CWWKF0011I message to the messages.log using the supplied timeout
int	waitForStop()	Wait for the Liberty server to stop using the default timeout
int	waitForStop(int timeout)	Wait for the Liberty server to stop using the supplied timeout
boolean	waitForStopMessage()	Wait for the Liberty server to issue the CWWKE0036I message to the messages.log using the default timeout
boolean	waitForStopMessage(int timeout)	Wait for the Liberty server to issue the CWWKE0036I message to the messages.log using the supplied timeout

Method Details

setServerName

void setServerName(String serverName)

Provides the Liberty Server Name

Parameters:

serverName -

Throws:

ZosLibertyServerException

setWlpInstallDir

void setWlpInstallDir(String wlpInstallDir)
               throws ZosLibertyServerException

Provides the location of the Liberty Install Directory ${WLP_INSTALL_DIR}

Parameters:

wlpInstallDir -

Throws:

ZosLibertyServerException

setWlpUserDir

void setWlpUserDir(String wlpUserDir)
            throws ZosLibertyServerException

Provides the location of the Liberty User Directory ${WLP_USER_DIR}

Parameters:

wlpUserDir -

Throws:

ZosLibertyServerException

setWlpOutputDir

void setWlpOutputDir(String wlpOutputDir)
              throws ZosLibertyServerException

Provides the location of the Liberty Output Directory ${WLP_OUTPUT_DIR}

Parameters:

wlpOutputDir -

Throws:

ZosLibertyServerException

setJavaHome

void setJavaHome(String javaHome)
          throws ZosLibertyServerException

Set the value of JAVA_HOME for this Liberty server

Parameters:

javaHome -

Throws:

ZosLibertyServerException

getVersion

String getVersion()
           throws ZosLibertyServerException

Returns the Liberty version

Returns:

Liberty version

Throws:

ZosLibertyServerException

getServerName

String getServerName()

Returns the Liberty Server Name

Returns:

the Liberty Server Name

getWlpInstallDir

IZosUNIXFile getWlpInstallDir()
                       throws ZosLibertyServerException

Returns the Liberty Install Directory ${WLP_INSTALL_DIR} as a IZosUNIXFile object

Returns:

the Liberty Install Directory

Throws:

ZosLibertyServerException

getWlpUserDir

IZosUNIXFile getWlpUserDir()
                    throws ZosLibertyServerException

Returns the Liberty User Directory ${WLP_USER_DIR} as a IZosUNIXFile object

Returns:

the Liberty User Directory

Throws:

ZosLibertyServerException

getWlpOutputDir

IZosUNIXFile getWlpOutputDir()
                      throws ZosLibertyServerException

Returns the Liberty Output Directory ${WLP_OUTPUT_DIR} as a IZosUNIXFile object

Returns:

the Liberty Output Directory

Throws:

ZosLibertyServerException

getSharedAppDir

IZosUNIXFile getSharedAppDir()
                      throws ZosLibertyServerException

Returns the Liberty Shared Application Directory ${shared.app.dir} as a IZosUNIXFile object

Returns:

the Liberty Shared Application Directory

Throws:

ZosLibertyServerException

getServerConfigDir

IZosUNIXFile getServerConfigDir()
                         throws ZosLibertyServerException

Returns the Liberty Server Configuration Directory ${server.config.app.dir} as a IZosUNIXFile object

Returns:

the Liberty Server Configuration Directory

Throws:

ZosLibertyServerException

getServerOutputDir

IZosUNIXFile getServerOutputDir()
                         throws ZosLibertyServerException

Returns the Liberty Server Output Directory ${server.output.dir} as a IZosUNIXFile object

Returns:

the Liberty Server Output Directory

Throws:

ZosLibertyServerException

getSharedConfigDir

IZosUNIXFile getSharedConfigDir()
                         throws ZosLibertyServerException

Returns the Liberty Shared Configuration Directory ${shared.config.dir} as a IZosUNIXFile object

Returns:

the Liberty Shared Configuration Directory

Throws:

ZosLibertyServerException

getSharedResourcesDir

IZosUNIXFile getSharedResourcesDir()
                            throws ZosLibertyServerException

Returns the Liberty Shared Resources Directory ${shared.resources.dir} as a IZosUNIXFile object

Returns:

the Liberty Shared Resources Directory

Throws:

ZosLibertyServerException

getLogsDirectory

IZosUNIXFile getLogsDirectory()
                       throws ZosLibertyServerException

Get the Liberty server logs directory

Returns:

the Liberty server logs directory

Throws:

ZosLibertyServerException

getDropinsDir

IZosUNIXFile getDropinsDir()
                    throws ZosLibertyServerException

Get the Liberty server dropins directory

Returns:

the dropins directory

Throws:

ZosLibertyServerException

getJavaHome

IZosUNIXFile getJavaHome()
                  throws ZosLibertyServerException

Get the JAVA_HOME value for this Liberty server

Returns:

Throws:

ZosLibertyServerException

getZosImage

IZosImage getZosImage()

Get the zOS Image for this Liberty server

Returns:

setServerXml

void setServerXml(IZosLibertyServerXml serverXml)
           throws ZosLibertyServerException

Set the server.xml object for this Liberty server

Parameters:

serverXml - the IZosLibertyServerXml server.xml object

Throws:

ZosLibertyServerException

getServerXml

IZosLibertyServerXml getServerXml()
                           throws ZosLibertyServerException

Get the server.xml object for this Liberty server

Returns:

the server.xml

Throws:

ZosLibertyServerException

loadServerXmlFromFileSystem

IZosLibertyServerXml loadServerXmlFromFileSystem()
                                          throws ZosLibertyServerException

Load the content of the Liberty server.xml from the file system into the internal IZosLibertyServerXml object

Returns:

the server.xml

Throws:

ZosLibertyServerException

getLogs

IZosLibertyServerLogs getLogs()
                       throws ZosLibertyServerException

Get the contents of the Liberty servers logs directory

Returns:

the Liberty server logs

Throws:

ZosLibertyServerException

clearLogs

void clearLogs()
        throws ZosLibertyServerException

Clear the contents of the Liberty servers logs directory

Throws:

ZosLibertyServerException

checkpointLogs

void checkpointLogs()
             throws ZosLibertyServerException

Convenience method to checkpoint the known Liberty server logs, i.e. messages.log and trace.log

Throws:

ZosLibertyServerException

retrieveMessagesLog

String retrieveMessagesLog()
                    throws ZosLibertyServerException

Get the current contents of the Liberty server messages.log as a String

Returns:

the content of the messages.log or null if the file does not exist

Throws:

ZosLibertyServerException

retrieveTraceLog

String retrieveTraceLog()
                 throws ZosLibertyServerException

Get the current contents of the Liberty server trace.log as a String

Returns:

the content of the messages.log or null if the file does not exist

Throws:

ZosLibertyServerException

retrieveMessagesLogSinceCheckpoint

String retrieveMessagesLogSinceCheckpoint()
                                   throws ZosLibertyServerException

Get the current contents of the Liberty server messages.log as a String since the last checkpoint

Returns:

the content of the messages.log

Throws:

ZosLibertyServerException

retrieveTraceLogSinceCheckpoint

String retrieveTraceLogSinceCheckpoint()
                                throws ZosLibertyServerException

Get the current contents of the Liberty server trace.log as a String since the last checkpoint

Returns:

the content of the messages.log

Throws:

ZosLibertyServerException

build

void build()
    throws ZosLibertyServerException

Builds the the Liberty server on the zOS UNIX file system from any objects that have been created such as the server.xml

Throws:

ZosLibertyServerException

create

int create()
    throws ZosLibertyServerException

Create a Liberty server using the server create command

Returns:

server command return code

Throws:

ZosLibertyServerException

start

int start()
   throws ZosLibertyServerException

Start the Liberty server using the server start command

Returns:

server command return code

Throws:

ZosLibertyServerException

run

int run()
 throws ZosLibertyServerException

Run the Liberty server as a zOS batch job

Returns:

server command return code

Throws:

ZosLibertyServerException

waitForStart

int waitForStart()
          throws ZosLibertyServerException

Wait for the Liberty server to start using the default timeout

Returns:

the return code from the server status command

Throws:

ZosLibertyServerException

waitForStart

int waitForStart(int timeout)
          throws ZosLibertyServerException

Wait for the Liberty server to start using the supplied timeout

Parameters:

timeout - the timeout in seconds

Returns:

the return code from the server status command

Throws:

ZosLibertyServerException

waitForStartMessage

boolean waitForStartMessage()
                     throws ZosLibertyServerException

Wait for the Liberty server to issue the CWWKF0011I message to the messages.log using the default timeout

Returns:

true if message was found in log

Throws:

ZosLibertyServerException

waitForStartMessage

boolean waitForStartMessage(int timeout)
                     throws ZosLibertyServerException

Wait for the Liberty server to issue the CWWKF0011I message to the messages.log using the supplied timeout

Parameters:

timeout - the timeout in seconds

Returns:

true if message was found in log

Throws:

ZosLibertyServerException

stop

int stop()
  throws ZosLibertyServerException

Stop the Liberty server

Returns:

the return code from the server status command

Throws:

ZosLibertyServerException

waitForStop

int waitForStop()
         throws ZosLibertyServerException

Wait for the Liberty server to stop using the default timeout

Returns:

the return code from the server status command

Throws:

ZosLibertyServerException

waitForStop

int waitForStop(int timeout)
         throws ZosLibertyServerException

Wait for the Liberty server to stop using the supplied timeout

Parameters:

timeout - the timeout in seconds

Returns:

the return code from the server status command

Throws:

ZosLibertyServerException

waitForStopMessage

boolean waitForStopMessage()
                    throws ZosLibertyServerException

Wait for the Liberty server to issue the CWWKE0036I message to the messages.log using the default timeout

Returns:

true if message was found in log

Throws:

ZosLibertyServerException

waitForStopMessage

boolean waitForStopMessage(int timeout)
                    throws ZosLibertyServerException

Wait for the Liberty server to issue the CWWKE0036I message to the messages.log using the supplied timeout

Parameters:

timeout - the timeout in seconds

Returns:

true if message was found in log

Throws:

ZosLibertyServerException

status

int status()
    throws ZosLibertyServerException

Get the Liberty sever status using the server status command

Returns:

the return code from the server status command

Throws:

ZosLibertyServerException

delete

void delete()
     throws ZosLibertyServerException

Delete the Liberty server files and directories

Throws:

ZosLibertyServerException

setDefaultHttpEndpoint

void setDefaultHttpEndpoint(String host,
 int httpPort,
 int httpsPort)
                     throws ZosLibertyServerException

Convenience method to create or replace the defaultHttpEndpoint element in the Liberty server server.xml

NOTE: This method loads the server.xml from the file system, updates the XML and stores it back on the file system

Parameters:

host - the value for the host property. The property will not be set when the value is null

httpPort - the value of the httpPort property. The property will not be set when the value less than 0

httpsPort - the value of the httpPorts property. The property will not be set when the value less than 0

Throws:

ZosLibertyServerException

listFeatures

List<String> listFeatures()
                   throws ZosLibertyServerException

Convenience method to list the current features listed in the featureManager element in the Liberty server server.xml

NOTE: This method loads the server.xml from the file system

Returns:

a list of features

Throws:

ZosLibertyServerException

addFeature

void addFeature(String feature)
         throws ZosLibertyServerException

Convenience method to add a feature to the Liberty server server.xml

NOTE: This method loads the server.xml from the file system, updates the XML and stores it back on the file system

Parameters:

feature - the feature to add

Throws:

ZosLibertyServerException

removeFeature

void removeFeature(String feature)
            throws ZosLibertyServerException

Convenience method remove a feature from the Liberty server server.xml

NOTE: This method loads the server.xml from the file system, updates the XML and stores it back on the file system

Parameters:

feature - the feature to remove

Throws:

ZosLibertyServerException

deployApplication

void deployApplication(Class<?> testClass,
 String path,
 String targetLocation,
 IZosLibertyServer.ApplicationType type,
 String name,
 String contextRoot)
                throws ZosLibertyServerException

Deploy an application to the Liberty server. This method copies the application archive file to the zOS UNIX file system and creates an application element in the server.xml.

Parameters:

testClass - a

invalid @link

{@link class

} in the same bundle containing the application archive file, use this.getClass()

path - the path in the bundle to the application archive file

targetLocation - the location on the zOS UNIX file system to store the application archive file. If the value is null, ${shared.app.dir}/fileName will be used

type - the application type

name - the name of the application

contextRoot - the application context-root. Can be null

Throws:

ZosLibertyServerException

deployApplicationToDropins

void deployApplicationToDropins(Class<?> testClass,
 String path)
                         throws ZosLibertyServerException

Deploy an application to the Liberty server dropins directory. This method copies the application archive file to the Liberty server dropins directory

Parameters:

testClass - a

invalid @link

{@link class

} in the same bundle containing the application archive file, use this.getClass()

path - the path in the bundle to the application archive file

Throws:

ZosLibertyServerException

removeApplication

void removeApplication(String name)
                throws ZosLibertyServerException

Remove an application from the Liberty server. This method removes the application from the server.xml and deletes the application archive file from the zOS UNIX file system. Set name to null to remove all applications from dropins

Parameters:

name - the application name

Throws:

ZosLibertyServerException

removeApplicationFromDropins

void removeApplicationFromDropins(String fileName)
                           throws ZosLibertyServerException

Remove an application from the Liberty server dropins directory. Set fileName to null to remove all applications from dropins

Parameters:

fileName - the name of the file in the dropins directory

Throws:

ZosLibertyServerException

waitForApplicationStart

boolean waitForApplicationStart(String name)
                         throws ZosLibertyServerException

Wait for an application to start using the default timeout by looking for CWWKZ0001I message in messages.log. If the messages.log has not been check-pointed, the whole file will be searched.

Parameters:

name - the application name

Returns:

true if application has started within the timeout

Throws:

ZosLibertyServerException

waitForApplicationStart

boolean waitForApplicationStart(String name,
 int timeout)
                         throws ZosLibertyServerException

Wait for an application to start using the supplied timeout by looking for CWWKZ0001I message in messages.log. If the messages.log has not been check-pointed, the whole file will be searched.

Parameters:

name - the application name

timeout - the timeout in seconds

Returns:

true if application has stopped within the timeout

Throws:

ZosLibertyServerException

waitForApplicationStop

boolean waitForApplicationStop(String name)
                        throws ZosLibertyServerException

Wait for an application to stop using the default timeout by looking for CWWKZ0009I message in messages.log. If the messages.log has not been check-pointed, the whole file will be searched.

Parameters:

name - the application name

Returns:

true if application has started within the timeout

Throws:

ZosLibertyServerException

waitForApplicationStop

boolean waitForApplicationStop(String name,
 int timeout)
                        throws ZosLibertyServerException

If the messages.log has not been check-pointed, the whole file will be searched.

Parameters:

name - the application name

timeout - the timeout in seconds

Returns:

true if application has stopped within the timeout

Throws:

ZosLibertyServerException

getKeystoreFile

IZosUNIXFile getKeystoreFile()
                      throws ZosLibertyServerException

Returns the keystore file for this Liberty server

Returns:

the Liberty key.p12 or key.jks keystore file. Will return null if the file does not exist.

Throws:

ZosLibertyServerException

securityUtilityEncode

String securityUtilityEncode(String password)
                      throws ZosLibertyServerException

Use the Liberty securityUtility command to encode a password

Parameters:

password - the password to encode

Returns:

the encoded password

Throws:

ZosLibertyServerException

securityUtilityGenerateKeystore

IZosUNIXFile securityUtilityGenerateKeystore(String password)
                                      throws ZosLibertyServerException

Use the Liberty securityUtility to create a new keyStore

Parameters:

password - the password used to create the certificate/keystore

Returns:

the new keystore file

Throws:

ZosLibertyServerException

saveToResultsArchive

void saveToResultsArchive()
                   throws ZosLibertyServerException

Store the content of the Liberty server logs and configuration to the default location in the Results Archive Store

Throws:

ZosLibertyServerException

saveToResultsArchive

void saveToResultsArchive(String rasPath)
                   throws ZosLibertyServerException

Store the content of the Liberty server logs and configuration to the Results Archive Store

Parameters:

rasPath - path in Results Archive Store

Throws:

ZosLibertyServerException