com.ibm.websphere.collective.repository

Interface RepositoryConfigurationMBean


  1. public interface RepositoryConfigurationMBean
RepositoryConfigurationMBean defines the administrative interface for replica set configuration.

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

Replicas may be added and removed from a live replica set. Additionally, the entire replica set may be redefined, as long as one of the replicas in the previous set exists in the new set.

All endpoints specified to this MBean expect the replicaHost and replicaPort values defined in the server.xml of each replica. For example:

 <collectiveController replicaHost="localhost" replicaPort="10011" />
 
The endpoint would be "localhost:10011".

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
OBJECT_NAME
A String representing the ObjectName that this MBean maps to.

Method Summary

Modifier and Type Method and Description
  1. boolean
addReplica(java.lang.String endpoint)
The addReplica operation adds a replica to the active replica set.
  1. boolean
reconfigureReplicas(java.lang.String endpoints)
The reconfigureReplicas operation redefines the active replica set.
  1. boolean
removeReplica(java.lang.String endpoint)
The removeReplica operation removes a replica from the existing replica set.

Field Detail

OBJECT_NAME

  1. static final java.lang.String OBJECT_NAME
A String representing the ObjectName that this MBean maps to.
See Also:

Method Detail

addReplica

  1. boolean addReplica(java.lang.String endpoint)
  2. throws java.io.IOException
  3. java.lang.IllegalArgumentException
The addReplica operation adds a replica to the active replica set. The replica to add is represented by an endpoint String.
Parameters:
endpoint - The identifier for a replica in the form "host:port".
Returns:
true if the replica addition was successful, false if the operation was not successful.
Throws:
java.io.IOException - If there was any problem completing the request
java.lang.IllegalArgumentException - If the endpoint is not valid

reconfigureReplicas

  1. boolean reconfigureReplicas(java.lang.String endpoints)
  2. throws java.io.IOException
  3. java.lang.IllegalArgumentException
The reconfigureReplicas operation redefines the active replica set. The new active replica set will be comprised solely of the supplied endpoints. The replicas for reconfiguration are represented as a space delimited list endpoints.
Parameters:
endpoints - A space delimited list of the replicas of the reconfigured replica set in the form "host:port host:port".
Returns:
true if the replica reconfiguration was successful, false if the operation was not successful.
Throws:
java.io.IOException - If there was any problem completing the request
java.lang.IllegalArgumentException - If the endpoint list is not valid

removeReplica

  1. boolean removeReplica(java.lang.String endpoint)
  2. throws java.io.IOException
  3. java.lang.IllegalArgumentException
The removeReplica operation removes a replica from the existing replica set. The replica to remove is represented by an endpoint String.
Parameters:
endpoint - The identifier for a replica in the form "host:port".
Returns:
true if the replica removal was successful, false if the operation was not successful.
Throws:
java.io.IOException - If there was any problem completing the request
java.lang.IllegalArgumentException - If the endpoint is not valid