com.ibm.websphere.collective.controller
Interface RoutingContextMBean


public interface RoutingContextMBean

This MBean provides routing context for MBean operations used with the IBM JMX REST Connector.

The ObjectName for this MBean is "WebSphere:feature=collectiveController,type=RoutingContext,name=RoutingContext".


Field Summary
static java.lang.String OBJECT_NAME
          A string representing the ObjectName that this MBean maps to.
 
Method Summary
 void assignHostContext(java.lang.String hostName)
          This method assigns a host to the routing context.
 void assignServerContext(java.lang.String hostName, java.lang.String wlpUserDir, java.lang.String serverName)
          This method assigns a server within the given host, user directory and server name to the routing context.
 

Field Detail

OBJECT_NAME

static final java.lang.String OBJECT_NAME
A string representing the ObjectName that this MBean maps to.

See Also:
Constant Field Values
Method Detail

assignServerContext

void assignServerContext(java.lang.String hostName,
                         java.lang.String wlpUserDir,
                         java.lang.String serverName)
This method assigns a server within the given host, user directory and server name to the routing context. This is used when routing requests to a specific target server.

Calling this method will override any previous context assignments.

Parameters:
hostName - The host name. Must not be null or an empty string. This host name should match the host name set to the defaultHostName Must not be null or an empty string.
wlpUserDir - The canonical path for the user directory of server. This should match the WLP_USER_DIR environment variable for the server. Must not be null or an empty string. Must not have a trailing slash. Must not be encoded.
serverName - The server name. Must not be null or an empty string.

assignHostContext

void assignHostContext(java.lang.String hostName)
This method assigns a host to the routing context. This is used when routing requests to a specific host without specifying any particular target servers.

Calling this method will override any previous context assignments.

Parameters:
hostName - The host name. Must not be null or an empty string.