|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDirectoryServiceProxy
Remote interface to a runtime instance of a DirectoryService.
Management attributes and operations are documented in this interface.
An implementation of this interface can be created using the MFProxyFactory class. Each implementation instance is valid for the life of the provided JMS/JMX Connector and MBean ObjectName. The implementation is built using remote JMX MBeanServer calls.
For each JMX MBean attribute, this interface provides an associated get method (for readable attributes) and/or a set method (for writable attributes).
For each JMX MBean operation, this interface provides an associated method with a signature as described by the MBean's operation meta-data. Each JMX MBean operation has an associated impact:
All exceptions emitted by implementations are wrapped as a ProxyRuntimeException.
Field Summary | |
---|---|
static java.lang.String |
CONFIGURATION_STORAGE_CHANGE_NOTIFICATION_ID
Notification type constant for the notification configuration.storage.Change. |
static java.lang.String |
GLOBAL_ID
The well known global component identity for this singleton component. |
static java.lang.String |
SYSTEM_SECURITY_CONFIGUREPERMISSIONDENIED_NOTIFICATION_ID
Notification type constant for the notification system.security.ConfigurePermissionDenied. |
static java.lang.String |
SYSTEM_STATE_FAILOVER_NOTIFICATION_ID
Notification type constant for the notification system.state.Failover. |
static java.lang.String |
SYSTEM_STATE_OFFLINE_NOTIFICATION_ID
Notification type constant for the notification system.state.Offline. |
static java.lang.String |
SYSTEM_STATE_ONLINE_NOTIFICATION_ID
Notification type constant for the notification system.state.Online. |
Method Summary | |
---|---|
void |
addNotificationListener(NotificationListener listener,
NotificationFilter filter,
java.lang.Object handback)
Adds a notification listener. |
void |
clearError()
Invokes the clearError operation. |
java.lang.Boolean |
getAllowFailover()
Gets the value of the AllowFailover attribute. |
AttributeList |
getAttributes(java.lang.String[] attributeNames)
Gets the values of several attributes of a DirectoryService component. |
IBackupStatus |
getBackupStatus()
Invokes the getBackupStatus operation. |
java.lang.String |
getClassname()
Gets the value of the Classname attribute. |
java.lang.String |
getClasspath()
Gets the value of the Classpath attribute. |
java.lang.String |
getConfigID()
Gets the value of the ConfigID attribute. |
java.lang.Integer |
getDirectoryServiceVersion()
Invokes the getDirectoryServiceVersion operation. |
java.lang.String |
getDomain()
Invokes the getDomain operation. |
java.lang.String |
getFaultToleranceRole()
Gets the value of the FaultToleranceRole attribute. |
java.lang.Short |
getFaultTolerantState()
Gets the value of the FaultTolerantState attribute. |
java.lang.String |
getFaultTolerantStateString()
Gets the value of the FaultTolerantStateString attribute. |
java.lang.String |
getLastError()
Gets the value of the LastError attribute. |
java.lang.Integer |
getLastErrorLevel()
Gets the value of the LastErrorLevel attribute. |
java.lang.String |
getLastErrorLevelString()
Gets the value of the LastErrorLevelString attribute. |
java.lang.String |
getReleaseVersion()
Gets the value of the ReleaseVersion attribute. |
java.lang.Short |
getState()
Gets the value of the State attribute. |
java.lang.String |
getStateString()
Gets the value of the StateString attribute. |
java.lang.Integer |
getTraceMask()
Gets the value of the TraceMask attribute. |
java.lang.String |
getTraceMaskValues()
Gets the value of the TraceMaskValues attribute. |
java.lang.Long |
getUptime()
Gets the value of the Uptime attribute. |
java.lang.Boolean |
leaseLock(java.lang.String lockName,
java.lang.String key,
java.lang.Integer leaseDuration)
Invokes the leaseLock operation. |
java.lang.String[] |
listExternalDomainWithManagementSPI()
Invokes the listExternalDomainWithManagementSPI operation. |
void |
releaseLock(java.lang.String lockName,
java.lang.String key)
Invokes the releaseLock operation. |
java.lang.Boolean |
reloadExternalAuthenticationDomain(java.lang.String mfDomainDescriptor)
Invokes the reloadExternalAuthenticationDomain operation. |
void |
removeNotificationListener(NotificationListener listener)
Removes a notification listener. |
void |
setAllowFailover(java.lang.Boolean value)
Sets the value of the AllowFailover attribute. |
AttributeList |
setAttributes(AttributeList attributes)
Sets the values of several attributes of a DirectoryService component. |
void |
setTraceMask(java.lang.Integer value)
Sets the value of the TraceMask attribute. |
void |
start()
Invokes the start operation. |
void |
startBackup(java.lang.String backupDir,
java.lang.Boolean overwrite)
Invokes the startBackup operation. |
void |
stop()
Invokes the stop operation. |
Field Detail |
---|
static final java.lang.String CONFIGURATION_STORAGE_CHANGE_NOTIFICATION_ID
Description: Configuration change(s) propagated by the Directory Services.
configuration.storage.Change
static final java.lang.String GLOBAL_ID
static final java.lang.String SYSTEM_SECURITY_CONFIGUREPERMISSIONDENIED_NOTIFICATION_ID
Description: Standby container has failed over to become the active container.
static final java.lang.String SYSTEM_STATE_FAILOVER_NOTIFICATION_ID
Description: Standby service has failed over to become the active service.
system.state.Failover
static final java.lang.String SYSTEM_STATE_OFFLINE_NOTIFICATION_ID
Description: Component stop complete.
system.state.Offline
static final java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID
Description: Component start complete.
system.state.Online
Method Detail |
---|
void addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback)
A DirectoryService component publishes the following notifications:
configuration.storage.Change
system.security.ConfigurePermissionDenied
system.state.Failover
system.state.Offline
system.state.Online
listener
- The listener object which will handle the notifications emitted component.filter
- The filter object. If filter is null, no filtering will be performed before handling notifications.handback
- The context to be sent to the listener when a notification is emitted.removeNotificationListener(javax.management.NotificationListener)
void clearError()
Clear existing error condition.
Impact: ACTION
getLastErrorLevel()
java.lang.Boolean getAllowFailover()
setAllowFailover(java.lang.Boolean)
AttributeList getAttributes(java.lang.String[] attributeNames)
Getting multiple attribute values at once is typically more efficient than getting individual attribute values.
Readable attributes (and their datatypes) exposed by a DirectoryService are:
AllowFailover
(java.lang.Boolean)
Classname
(java.lang.String)
Classpath
(java.lang.String)
ConfigID
(java.lang.String)
FaultToleranceRole
(java.lang.String)
FaultTolerantState
(java.lang.Short)
FaultTolerantStateString
(java.lang.String)
LastError
(java.lang.String)
LastErrorLevel
(java.lang.Integer)
LastErrorLevelString
(java.lang.String)
ReleaseVersion
(java.lang.String)
State
(java.lang.Short)
StateString
(java.lang.String)
TraceMask
(java.lang.Integer)
TraceMaskValues
(java.lang.String)
Uptime
(java.lang.Long)
attributeNames
- A list of the attribute names of attributes to be retrieved.
setAttributes(javax.management.AttributeList)
IBackupStatus getBackupStatus()
Return a BackupStatus object with information about the last backup
Impact: INFO
java.lang.String getClassname()
java.lang.String getClasspath()
java.lang.String getConfigID()
java.lang.Integer getDirectoryServiceVersion()
Gets the Directory Service version.
Impact: INFO
java.lang.String getDomain()
Gets the domain name for the configuration domain the Directory Service maintains.
Impact: INFO
java.lang.String getFaultToleranceRole()
java.lang.Short getFaultTolerantState()
java.lang.String getFaultTolerantStateString()
java.lang.String getLastError()
java.lang.Integer getLastErrorLevel()
java.lang.String getLastErrorLevelString()
java.lang.String getReleaseVersion()
java.lang.Short getState()
getStateString()
,
IComponentState
java.lang.String getStateString()
getState()
,
IComponentState.STATE_TEXT
java.lang.Integer getTraceMask()
setTraceMask(java.lang.Integer)
,
getTraceMaskValues()
java.lang.String getTraceMaskValues()
getTraceMask()
,
setTraceMask(java.lang.Integer)
java.lang.Long getUptime()
java.lang.Boolean leaseLock(java.lang.String lockName, java.lang.String key, java.lang.Integer leaseDuration)
Leases the named lock against the given key for the given period. Returns true if the the lock was successfully acquired, false if not.
Impact: ACTION
lockName
- The name of the lock to be acquired.key
- The key under which the lock (if acquired) should be held.leaseDuration
- The duration the lock lease will remain in effect (cannot be (re)acquired using a different key). After the duration has expired the lock can be acquired under a different key.java.lang.String[] listExternalDomainWithManagementSPI()
Return list of external domain descriptors that have been configured with Management SPI.
Impact: INFO
void releaseLock(java.lang.String lockName, java.lang.String key)
Releases a previously acquired lock (if that lock is still held against the given key).
Impact: ACTION
lockName
- The name of the acquired lock.key
- The key under which the lock was acquired.java.lang.Boolean reloadExternalAuthenticationDomain(java.lang.String mfDomainDescriptor)
Reloads the external domain that matches the descriptor passed in.
Impact: ACTION
mfDomainDescriptor
- The name of the external domainvoid removeNotificationListener(NotificationListener listener)
This method will remove all the information related to the given listener.
listener
- The listener object which will handle the notifications emitted by the registered MBean.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, Object)
void setAllowFailover(java.lang.Boolean value)
value
- When this Directory Service is in a standby state and this attribute is set to 'false', fault tolerant failover to active will not occur.getAllowFailover()
AttributeList setAttributes(AttributeList attributes)
Setting multiple attribute values at once is typically more efficient than setting individual attribute values.
Settable attributes (and their datatypes) exposed by a DirectoryService are:
AllowFailover
(java.lang.Boolean)
TraceMask
(java.lang.Integer)
attributes
- A list of attributes: The identification of the attributes to be set and the values they are to be set to.
getAttributes(java.lang.String[])
void setTraceMask(java.lang.Integer value)
value
- Debug bit mask.getTraceMask()
,
getTraceMaskValues()
void start()
Start providing service.
Impact: ACTION
stop()
void startBackup(java.lang.String backupDir, java.lang.Boolean overwrite)
Start the backup process asynchronously
Impact: ACTION
backupDir
- The directory to use for the backupoverwrite
- Overwrite the existing DS if there is one in the backup directoryvoid stop()
Stop providing service.
Impact: ACTION
start()
|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |