IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

com.ibm.websphere.objectgrid.gateway
Interface ManagementGateway


Deprecated. The static deployment topology is deprecated in version 7.0. Use the dynamic deployment topology.

public interface ManagementGateway

This interface represents the ManagementGateway process that enables cluster management using JMX MBeans when using the static deployment topology.

Since:
WAS XD 6.0.1
See Also:
ManagementGatewayFactory.getManagementGateway()

Method Summary
 String getClusterName()
          Deprecated. Gets the name of the ObjectGrid cluster to which the gateway process connects.
 int getConnectorPort()
          Deprecated. Gets the JMX connector port.
 ClientSecurityConfiguration getCsConfig()
          Deprecated. Gets the client security configuration used by the gateway process to connect to the ObjectGrid cluster.
 String getHost()
          Deprecated. Sets the host name used by the gateway process to connect to the ObjectGrid cluster.
 String getPort()
          Deprecated. Gets the connect port used by the gateway process to connect to the ObjectGrid cluster.
 int getRefreshInterval()
          Deprecated. Gets the amount of time in seconds between when MBean.
 boolean getSSLEnabled()
          Deprecated. Gets whether SSL is enabled on the gateway.
 boolean getTraceEnabled()
          Deprecated. Gets whether ObjectGrid trace is enabled on the gateway process.
 String getTraceFile()
          Deprecated. Gets the file name where trace data is written on the gateway process.
 String getTraceSpec()
          Deprecated. Gets the trace specification on the gateway process.
 void setClusterName(String clusterName)
          Deprecated. Sets the name of the ObjectGrid cluster to which the gateway process connects.
 void setConnectorPort(int port)
          Deprecated. Sets the JMX connector port.
 void setCsConfig(ClientSecurityConfiguration csConfig)
          Deprecated. Sets the client security configuration used by the gateway process to connect to the ObjectGrid cluster.
 void setHost(String host)
          Deprecated. Sets the host name used by the gateway process to connect to the ObjectGrid cluster.
 void setPort(String port)
          Deprecated. Sets the connect port used by the gateway process to connect to the ObjectGrid cluster.
 void setRefreshInterval(int refreshInterval)
          Deprecated. Sets the amount of time in seconds between when MBean.
 void setSSLEnabled(boolean sslEnabled)
          Deprecated. Sets whether SSL is enabled on the gateway.
 void setTraceEnabled(boolean traceEnabled)
          Deprecated. Sets whether ObjectGrid trace is enabled on the gateway process.
 void setTraceFile(String traceFile)
          Deprecated. Sets the file name to write trace data on the gateway process.
 void setTraceSpec(String traceSpec)
          Deprecated. Sets the trace specification on the gateway process.
 void startConnector()
          Deprecated. Starts the JMX MBean connector server.
 void stopConnector()
          Deprecated. Stops the JMX MBean connector server.
 

Method Detail

startConnector

void startConnector()
                    throws ConnectException,
                           ObjectGridRuntimeException
Deprecated. 
Starts the JMX MBean connector server.

Throws:
ConnectException - If the management gateway cannot connect to the ObjectGrid cluster.
ObjectGridRuntimeException - If any MBean related operation fails.

stopConnector

void stopConnector()
Deprecated. 
Stops the JMX MBean connector server.


setConnectorPort

void setConnectorPort(int port)
Deprecated. 
Sets the JMX connector port.

Parameters:
port - the JMX connector port

getConnectorPort

int getConnectorPort()
Deprecated. 
Gets the JMX connector port.

Returns:
the argument that was passed to the setConnectorPort(int) method of this interface or -1 if setConnectorPort was not previously called for this object.
See Also:
setConnectorPort(int)

setCsConfig

void setCsConfig(ClientSecurityConfiguration csConfig)
Deprecated. 
Sets the client security configuration used by the gateway process to connect to the ObjectGrid cluster.

Parameters:
csConfig - a ClientSecurityConfiguration object.
See Also:
ClientSecurityConfiguration

getCsConfig

ClientSecurityConfiguration getCsConfig()
Deprecated. 
Gets the client security configuration used by the gateway process to connect to the ObjectGrid cluster.

Returns:
the argument that was passed to the setCsConfig(ClientSecurityConfiguration) method of this interface or null if setCsConfig was not previously called for this object.
See Also:
setCsConfig(ClientSecurityConfiguration), ClientSecurityConfiguration

setPort

void setPort(String port)
Deprecated. 
Sets the connect port used by the gateway process to connect to the ObjectGrid cluster.

Parameters:
port - a ObjectGrid server client access port to which a gateway server connects

getPort

String getPort()
Deprecated. 
Gets the connect port used by the gateway process to connect to the ObjectGrid cluster.

Returns:
the argument that was passed to the setPort(String) method of this interface or null if setPort was not previously called for this object.
See Also:
setPort(String)

setHost

void setHost(String host)
Deprecated. 
Sets the host name used by the gateway process to connect to the ObjectGrid cluster.

Parameters:
host - a ObjectGrid server host name to which a gateway server connects

getHost

String getHost()
Deprecated. 
Sets the host name used by the gateway process to connect to the ObjectGrid cluster.

Returns:
the argument that was passed to the setHost(String) method of this interface or null if setHost was not previously called for this object.
See Also:
setHost(String)

setSSLEnabled

void setSSLEnabled(boolean sslEnabled)
Deprecated. 
Sets whether SSL is enabled on the gateway.

Parameters:
sslEnabled - true if SSL is enabled on the gateway

getSSLEnabled

boolean getSSLEnabled()
Deprecated. 
Gets whether SSL is enabled on the gateway.

Returns:
the argument that was passed to the setSSLEnabled(boolean) method of this interface or false if setSSLEnabled was not previously called for this object.
See Also:
setSSLEnabled(boolean)

setClusterName

void setClusterName(String clusterName)
Deprecated. 
Sets the name of the ObjectGrid cluster to which the gateway process connects.

Parameters:
clusterName - the name of the ObjectGrid cluster

getClusterName

String getClusterName()
Deprecated. 
Gets the name of the ObjectGrid cluster to which the gateway process connects.

Returns:
the argument that was passed to the setClusterName(String) method of this interface or null if setClusterName was not previously called for this object.
See Also:
setClusterName(String)

setTraceEnabled

void setTraceEnabled(boolean traceEnabled)
Deprecated. 
Sets whether ObjectGrid trace is enabled on the gateway process.

Parameters:
traceEnabled - true if ObjectGrid trace is enabled
See Also:
ObjectGridManager.setTraceEnabled(boolean)

getTraceEnabled

boolean getTraceEnabled()
Deprecated. 
Gets whether ObjectGrid trace is enabled on the gateway process.

Returns:
the argument that was passed to the setTraceEnabled(boolean) method of this interface or false if setTraceEnabled was not previously called for this object.
See Also:
setTraceEnabled(boolean)

setTraceSpec

void setTraceSpec(String traceSpec)
Deprecated. 
Sets the trace specification on the gateway process.

Parameters:
traceSpec - the trace specification to set on the gateway process
See Also:
setTraceEnabled(boolean), ObjectGridManager.setTraceSpecification(String)

getTraceSpec

String getTraceSpec()
Deprecated. 
Gets the trace specification on the gateway process.

Returns:
the argument that was passed to the setTraceSpec(String) method of this interface or null if setTraceSpec was not previously called for this object.
See Also:
setTraceSpec(String)

setTraceFile

void setTraceFile(String traceFile)
Deprecated. 
Sets the file name to write trace data on the gateway process.

Parameters:
traceFile - output file name for gateway trace
See Also:
ObjectGridManager.setTraceFileName(String)

getTraceFile

String getTraceFile()
Deprecated. 
Gets the file name where trace data is written on the gateway process.

Returns:
the argument that was passed to the setTraceFile(String) method of this interface or null if setTraceFile was not previously called for this object.
See Also:
setTraceFile(String)

setRefreshInterval

void setRefreshInterval(int refreshInterval)
Deprecated. 
Sets the amount of time in seconds between when MBean. attributes are refreshed

Parameters:
refreshInterval - the refresh interval

getRefreshInterval

int getRefreshInterval()
Deprecated. 
Gets the amount of time in seconds between when MBean. attributes are refreshed

Returns:
the argument that was passed to the setRefreshInterval(int) method of this interface or 120 if setRefreshInterval was not previously called for this object.
See Also:
setRefreshInterval(int)

IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.