public interface DynamicRoutingMBean
The Apache or IHS WebSphere plugin connects to a REST service in order to provide ODR-style capabilities. The DynamicRouting MBean provides operations to manage this REST service.
The ObjectName for this MBean is "WebSphere:feature=dynamicRouting,type=DynamicRouting,name=DynamicRouting".
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EVENT_TYPE_KEY
Use this event property key to discover event type.
|
static java.lang.String |
EVENT_TYPE_TRACESPECIFICATION_VALUE
Use this key value to test the event type.
|
static java.lang.String |
OBJECT_NAME
A String representing the
ObjectName that this MBean maps to. |
static java.lang.String |
OPERATION_EXCEPTION
Exception key for the operation result map.
|
static java.lang.String |
OPERATION_EXCEPTION_MESSAGE
Exception message key for the operation result map.
|
static java.lang.String |
PUBLISH_TOPIC
Topic space to which events are published.
|
static java.lang.String |
STATUS_NOT_STARTED
Status value for a fully stopped cluster (no members are started).
|
static java.lang.String |
STATUS_PARTIALLY_STARTED
Status value for a partially started cluster (some members are started).
|
static java.lang.String |
STATUS_STARTED
Status value for a fully started cluster (all members are started).
|
Modifier and Type | Method and Description |
---|---|
void |
dumpPOSTResponse(java.lang.String fileName,
java.lang.String correlator)
Dumps the JSON that is sent to a client's POST request by the
Dynamic Routing service.
|
java.util.Collection<java.lang.String> |
generatePluginConfig(java.lang.String pluginRoot,
java.lang.String webserverName)
Generate a plugin-cfg.xml with the Intelligent Management stanza.
|
org.w3c.dom.Document |
generatePluginConfigContent(java.lang.String pluginRoot,
java.lang.String webserverName)
Generate a plugin-cfg.xml content with the Intelligent Management stanza
|
java.util.Map<java.lang.String,byte[]> |
genWebServerKeystore(java.lang.String keystorePassword,
java.util.Map<java.lang.String,java.lang.Object> certProps)
Returns a keystore with the keys and certificates needed for a web server to communicate
with the collective.
|
java.lang.String |
getConnectorClusterName()
Returns the name of the connector cluster this controller belongs to, either specified in server.xml,
the collective name in the configuration repository, or "defaultCollective".
|
java.util.Collection<com.ibm.ws.dynamic.routing.model.PluginTraceSpecification> |
getTraceSpecifications(java.lang.String webserver)
Returns a collection of the trace specifications that apply to the specified webserver.
|
java.util.Collection<com.ibm.ws.dynamic.routing.model.PluginTraceSpecification> |
retrieveAllTraceSpecifications()
Returns a collection of all the configured trace specifications.
|
static final java.lang.String OBJECT_NAME
ObjectName
that this MBean maps to.static final java.lang.String OPERATION_EXCEPTION
The Exception object thrown by the operation.
static final java.lang.String OPERATION_EXCEPTION_MESSAGE
The value of the Exception message thrown by the operation.
static final java.lang.String STATUS_STARTED
Returned by the getStatus() method.
static final java.lang.String STATUS_PARTIALLY_STARTED
Returned by the getStatus() method.
static final java.lang.String STATUS_NOT_STARTED
Returned by the getStatus() method.
static final java.lang.String PUBLISH_TOPIC
static final java.lang.String EVENT_TYPE_KEY
static final java.lang.String EVENT_TYPE_TRACESPECIFICATION_VALUE
java.util.Collection<java.lang.String> generatePluginConfig(java.lang.String pluginRoot, java.lang.String webserverName) throws javax.management.InstanceNotFoundException, javax.management.ReflectionException, javax.management.MBeanException, java.io.IOException, org.xml.sax.SAXException, javax.xml.transform.TransformerException
pluginRoot
- Path to plugin install root.
If null or empty string, the location specified in server.xml will be used.webserverName
- Target webserver name.
Multiple plugin-cfg.xml files may be generated by passing a comma-separated list of names.null
is not returned.javax.management.InstanceNotFoundException
javax.management.ReflectionException
javax.management.MBeanException
java.io.IOException
org.xml.sax.SAXException
javax.xml.transform.TransformerException
org.w3c.dom.Document generatePluginConfigContent(java.lang.String pluginRoot, java.lang.String webserverName) throws javax.management.InstanceNotFoundException, javax.management.ReflectionException, javax.management.MBeanException, java.io.IOException, org.xml.sax.SAXException, javax.xml.transform.TransformerException
pluginRoot
- Path to plugin install root.
If null or empty string, the location specified in server.xml will be used.webserverName
- Target webserver name.javax.management.InstanceNotFoundException
javax.management.ReflectionException
javax.management.MBeanException
java.io.IOException
org.xml.sax.SAXException
javax.xml.transform.TransformerException
java.lang.String getConnectorClusterName()
null
is not returned.java.util.Collection<com.ibm.ws.dynamic.routing.model.PluginTraceSpecification> getTraceSpecifications(java.lang.String webserver)
null
is not returned.java.util.Collection<com.ibm.ws.dynamic.routing.model.PluginTraceSpecification> retrieveAllTraceSpecifications()
null
is not returned.void dumpPOSTResponse(java.lang.String fileName, java.lang.String correlator)
fileName
- name of the file to which JSON is dumped to.
Writes to log if the file cannot be opened or if fileName is null
correlator
- string that is output before data is dumped to the file. can be null
.java.util.Map<java.lang.String,byte[]> genWebServerKeystore(java.lang.String keystorePassword, java.util.Map<java.lang.String,java.lang.Object> certProps) throws java.io.IOException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.security.cert.CertificateException, java.security.KeyStoreException
keystorePassword
- the password to assign to the key storecertProps
- contains nothing currently, there are no options when creating web server certificates.java.io.IOException
java.lang.IllegalArgumentException
java.lang.IllegalStateException
java.security.cert.CertificateException
java.security.KeyStoreException