Package org.serviceconnector.api.cln

Class SCMgmtClient

java.lang.Object

org.serviceconnector.api.cln.SCClient

org.serviceconnector.api.cln.SCMgmtClient

public class SCMgmtClient
extends SCClient

Management client to an SC.

Author:

JTrnka

Field Summary

Fields inherited from class org.serviceconnector.api.cln.SCClient

attached, requester

Constructor Summary

Constructors

Constructor	Description
SCMgmtClient(String host, int port)	Instantiates a new SC management client.
SCMgmtClient(String host, int port, ConnectionType connectionType)	Instantiates a new SC management client.

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears the cache.
void	clearCache(int operationTimeoutSeconds)	Clears the cache for given service name.
void	disableService(int operationTimeoutSeconds, String serviceName)	Disable service on SC.
void	disableService(String serviceName)	Disable service on SC with default operation timeout.
void	dump()	Request dump of SC.
void	dump(int operationTimeoutSeconds)	Request dump of SC.
void	enableService(int operationTimeoutSeconds, String serviceName)	Enable service on SC.
void	enableService(String serviceName)	Disable service on SC with default operation timeout.
void	killSC()	Kill SC.

Methods inherited from class org.serviceconnector.api.cln.SCClient

attach, attach, changeCacheGuardian, changeGuardian, detach, detach, getCacheGuardian, getConnectionType, getHost, getKeepAliveIntervalSeconds, getKeepAliveTimeoutSeconds, getMaxConnections, getPort, getSCVersion, getServiceConfiguration, getServiceConfiguration, getStateOfServices, getStateOfServices, getTCPKeepAlive, getWorkload, getWorkload, inspectCache, inspectCache, isAttached, isCacheGuardianActive, isServiceEnabled, isServiceEnabled, newFileService, newPublishService, newSessionService, setKeepAliveIntervalSeconds, setKeepAliveTimeoutSeconds, setMaxConnections, setTCPKeepAlive, startCacheGuardian, startCacheGuardian, stopCacheGuardian, stopCacheGuardian

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SCMgmtClient

public SCMgmtClient(String host,
 int port)

Instantiates a new SC management client.

Parameters:

host - the host

port - the port

SCMgmtClient

public SCMgmtClient(String host,
 int port,
 ConnectionType connectionType)

Instantiates a new SC management client.

Parameters:

host - the host

port - the port

connectionType - the connection type

Method Details

disableService

public void disableService(String serviceName)
                    throws SCServiceException,
UnsupportedEncodingException

Disable service on SC with default operation timeout.

Parameters:

serviceName - the service name

Throws:

SCServiceException - client not attached
manage call to SC failed
body not null after manage call

UnsupportedEncodingException - encoding of request URL failed

disableService

public void disableService(int operationTimeoutSeconds,
 String serviceName)
                    throws SCServiceException,
UnsupportedEncodingException

Disable service on SC.

Parameters:

operationTimeoutSeconds - the allowed time in seconds to complete the operation

serviceName - the service name

Throws:

SCServiceException - client not attached
manage call to SC failed
body not null after manage call

UnsupportedEncodingException - encoding of request URL failed

enableService

public void enableService(String serviceName)
                   throws SCServiceException,
UnsupportedEncodingException

Disable service on SC with default operation timeout.

Parameters:

serviceName - the service name

Throws:

SCServiceException - client not attached
manage call to SC failed
body not null after manage call

UnsupportedEncodingException - encoding of request failed

enableService

public void enableService(int operationTimeoutSeconds,
 String serviceName)
                   throws SCServiceException,
UnsupportedEncodingException

Enable service on SC.

Parameters:

operationTimeoutSeconds - the allowed time in seconds to complete the operation

serviceName - the service name

Throws:

SCServiceException - client not attached
manage call to SC failed
body not null after manage call

UnsupportedEncodingException - encoding of request failed

clearCache

public void clearCache()
                throws SCServiceException,
UnsupportedEncodingException

Clears the cache. Uses default operation timeout to complete operation.

Throws:

SCServiceException - client not attached
body not null after manage call
manage call to SC failed

UnsupportedEncodingException - encoding of request URL failed

clearCache

public void clearCache(int operationTimeoutSeconds)
                throws SCServiceException,
UnsupportedEncodingException

Clears the cache for given service name.

Parameters:

operationTimeoutSeconds - the allowed time in seconds to complete the operation

Throws:

SCServiceException - client not attached
body not null after manage call
manage call to SC failed

UnsupportedEncodingException - encoding of request URL failed

dump

public void dump()
          throws SCServiceException,
UnsupportedEncodingException

Request dump of SC. Uses default operation timeout to complete operation.

Throws:

SCServiceException - client not attached
manage call to SC failed

UnsupportedEncodingException - encoding of request URL failed

dump

public void dump(int operationTimeoutSeconds)
          throws SCServiceException,
UnsupportedEncodingException

Request dump of SC.

Parameters:

operationTimeoutSeconds - the allowed time in seconds to complete the operation

Throws:

SCServiceException - client not attached
manage call to SC failed

UnsupportedEncodingException - encoding of request URL failed

killSC

public void killSC()
            throws SCServiceException,
UnsupportedEncodingException

Kill SC.

Throws:

SCServiceException - client not attached
manage call to SC failed

UnsupportedEncodingException - encoding of request URL failed