|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RootCfgClient
A client-side interface for reading and modifying Root settings.
The root configuration provides an entry point to the rest of the OpenDS Directory Server configuration.
Method Summary | ||
---|---|---|
|
createAccountStatusNotificationHandler(ManagedObjectDefinition<C,? extends AccountStatusNotificationHandlerCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Account Status Notification Handler. |
|
|
createAlertHandler(ManagedObjectDefinition<C,? extends AlertHandlerCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Alert Handler. |
|
|
createAttributeSyntax(ManagedObjectDefinition<C,? extends AttributeSyntaxCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Attribute Syntax. |
|
|
createBackend(ManagedObjectDefinition<C,? extends BackendCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Backend. |
|
|
createCertificateMapper(ManagedObjectDefinition<C,? extends CertificateMapperCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Certificate Mapper. |
|
|
createConnectionHandler(ManagedObjectDefinition<C,? extends ConnectionHandlerCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Connection Handler. |
|
|
createEntryCache(ManagedObjectDefinition<C,? extends EntryCacheCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Entry Cache. |
|
|
createExtendedOperationHandler(ManagedObjectDefinition<C,? extends ExtendedOperationHandlerCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Extended Operation Handler. |
|
|
createGroupImplementation(ManagedObjectDefinition<C,? extends GroupImplementationCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Group Implementation. |
|
|
createIdentityMapper(ManagedObjectDefinition<C,? extends IdentityMapperCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Identity Mapper. |
|
|
createKeyManagerProvider(ManagedObjectDefinition<C,? extends KeyManagerProviderCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Key Manager Provider. |
|
|
createLogPublisher(ManagedObjectDefinition<C,? extends LogPublisherCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Log Publisher. |
|
|
createLogRetentionPolicy(ManagedObjectDefinition<C,? extends LogRetentionPolicyCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Log Retention Policy. |
|
|
createLogRotationPolicy(ManagedObjectDefinition<C,? extends LogRotationPolicyCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Log Rotation Policy. |
|
|
createMatchingRule(ManagedObjectDefinition<C,? extends MatchingRuleCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Matching Rule. |
|
|
createMonitorProvider(ManagedObjectDefinition<C,? extends MonitorProviderCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Monitor Provider. |
|
|
createNetworkGroup(ManagedObjectDefinition<C,? extends NetworkGroupCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Network Group. |
|
|
createPasswordGenerator(ManagedObjectDefinition<C,? extends PasswordGeneratorCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Password Generator. |
|
|
createPasswordPolicy(ManagedObjectDefinition<C,? extends PasswordPolicyCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Password Policy. |
|
|
createPasswordStorageScheme(ManagedObjectDefinition<C,? extends PasswordStorageSchemeCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Password Storage Scheme. |
|
|
createPasswordValidator(ManagedObjectDefinition<C,? extends PasswordValidatorCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Password Validator. |
|
|
createSASLMechanismHandler(ManagedObjectDefinition<C,? extends SASLMechanismHandlerCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new SASL Mechanism Handler. |
|
|
createSynchronizationProvider(ManagedObjectDefinition<C,? extends SynchronizationProviderCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Synchronization Provider. |
|
|
createTrustManagerProvider(ManagedObjectDefinition<C,? extends TrustManagerProviderCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Trust Manager Provider. |
|
|
createVirtualAttribute(ManagedObjectDefinition<C,? extends VirtualAttributeCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Virtual Attribute. |
|
|
createWorkflow(ManagedObjectDefinition<C,? extends WorkflowCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Workflow. |
|
|
createWorkflowElement(ManagedObjectDefinition<C,? extends WorkflowElementCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Workflow Element. |
|
ManagedObjectDefinition<? extends RootCfgClient,? extends RootCfg> |
definition()
Get the configuration definition associated with this Root. |
|
AccessControlHandlerCfgClient |
getAccessControlHandler()
Gets the Access Control Handler. |
|
AccountStatusNotificationHandlerCfgClient |
getAccountStatusNotificationHandler(java.lang.String name)
Gets the named Account Status Notification Handler. |
|
AlertHandlerCfgClient |
getAlertHandler(java.lang.String name)
Gets the named Alert Handler. |
|
AttributeSyntaxCfgClient |
getAttributeSyntax(java.lang.String name)
Gets the named Attribute Syntax. |
|
BackendCfgClient |
getBackend(java.lang.String name)
Gets the named Backend. |
|
CertificateMapperCfgClient |
getCertificateMapper(java.lang.String name)
Gets the named Certificate Mapper. |
|
ConnectionHandlerCfgClient |
getConnectionHandler(java.lang.String name)
Gets the named Connection Handler. |
|
CryptoManagerCfgClient |
getCryptoManager()
Gets the Crypto Manager. |
|
EntryCacheCfgClient |
getEntryCache(java.lang.String name)
Gets the named Entry Cache. |
|
ExtendedOperationHandlerCfgClient |
getExtendedOperationHandler(java.lang.String name)
Gets the named Extended Operation Handler. |
|
GlobalCfgClient |
getGlobalConfiguration()
Gets the Global Configuration. |
|
GroupImplementationCfgClient |
getGroupImplementation(java.lang.String name)
Gets the named Group Implementation. |
|
IdentityMapperCfgClient |
getIdentityMapper(java.lang.String name)
Gets the named Identity Mapper. |
|
KeyManagerProviderCfgClient |
getKeyManagerProvider(java.lang.String name)
Gets the named Key Manager Provider. |
|
LogPublisherCfgClient |
getLogPublisher(java.lang.String name)
Gets the named Log Publisher. |
|
LogRetentionPolicyCfgClient |
getLogRetentionPolicy(java.lang.String name)
Gets the named Log Retention Policy. |
|
LogRotationPolicyCfgClient |
getLogRotationPolicy(java.lang.String name)
Gets the named Log Rotation Policy. |
|
MatchingRuleCfgClient |
getMatchingRule(java.lang.String name)
Gets the named Matching Rule. |
|
MonitorProviderCfgClient |
getMonitorProvider(java.lang.String name)
Gets the named Monitor Provider. |
|
NetworkGroupCfgClient |
getNetworkGroup(java.lang.String name)
Gets the named Network Group. |
|
PasswordGeneratorCfgClient |
getPasswordGenerator(java.lang.String name)
Gets the named Password Generator. |
|
PasswordPolicyCfgClient |
getPasswordPolicy(java.lang.String name)
Gets the named Password Policy. |
|
PasswordStorageSchemeCfgClient |
getPasswordStorageScheme(java.lang.String name)
Gets the named Password Storage Scheme. |
|
PasswordValidatorCfgClient |
getPasswordValidator(java.lang.String name)
Gets the named Password Validator. |
|
PluginRootCfgClient |
getPluginRoot()
Gets the Plugin Root. |
|
RootDNCfgClient |
getRootDN()
Gets the Root DN. |
|
RootDSEBackendCfgClient |
getRootDSEBackend()
Gets the Root DSE Backend. |
|
SASLMechanismHandlerCfgClient |
getSASLMechanismHandler(java.lang.String name)
Gets the named SASL Mechanism Handler. |
|
SynchronizationProviderCfgClient |
getSynchronizationProvider(java.lang.String name)
Gets the named Synchronization Provider. |
|
TrustManagerProviderCfgClient |
getTrustManagerProvider(java.lang.String name)
Gets the named Trust Manager Provider. |
|
VirtualAttributeCfgClient |
getVirtualAttribute(java.lang.String name)
Gets the named Virtual Attribute. |
|
WorkflowCfgClient |
getWorkflow(java.lang.String name)
Gets the named Workflow. |
|
WorkflowElementCfgClient |
getWorkflowElement(java.lang.String name)
Gets the named Workflow Element. |
|
WorkQueueCfgClient |
getWorkQueue()
Gets the Work Queue. |
|
java.lang.String[] |
listAccountStatusNotificationHandlers()
Lists the Account Status Notification Handlers. |
|
java.lang.String[] |
listAlertHandlers()
Lists the Alert Handlers. |
|
java.lang.String[] |
listAttributeSyntaxes()
Lists the Attribute Syntaxes. |
|
java.lang.String[] |
listBackends()
Lists the Backends. |
|
java.lang.String[] |
listCertificateMappers()
Lists the Certificate Mappers. |
|
java.lang.String[] |
listConnectionHandlers()
Lists the Connection Handlers. |
|
java.lang.String[] |
listEntryCaches()
Lists the Entry Caches. |
|
java.lang.String[] |
listExtendedOperationHandlers()
Lists the Extended Operation Handlers. |
|
java.lang.String[] |
listGroupImplementations()
Lists the Group Implementations. |
|
java.lang.String[] |
listIdentityMappers()
Lists the Identity Mappers. |
|
java.lang.String[] |
listKeyManagerProviders()
Lists the Key Manager Providers. |
|
java.lang.String[] |
listLogPublishers()
Lists the Log Publishers. |
|
java.lang.String[] |
listLogRetentionPolicies()
Lists the Log Retention Policies. |
|
java.lang.String[] |
listLogRotationPolicies()
Lists the Log Rotation Policies. |
|
java.lang.String[] |
listMatchingRules()
Lists the Matching Rules. |
|
java.lang.String[] |
listMonitorProviders()
Lists the Monitor Providers. |
|
java.lang.String[] |
listNetworkGroups()
Lists the Network Groups. |
|
java.lang.String[] |
listPasswordGenerators()
Lists the Password Generators. |
|
java.lang.String[] |
listPasswordPolicies()
Lists the Password Policies. |
|
java.lang.String[] |
listPasswordStorageSchemes()
Lists the Password Storage Schemes. |
|
java.lang.String[] |
listPasswordValidators()
Lists the Password Validators. |
|
java.lang.String[] |
listSASLMechanismHandlers()
Lists the SASL Mechanism Handlers. |
|
java.lang.String[] |
listSynchronizationProviders()
Lists the Synchronization Providers. |
|
java.lang.String[] |
listTrustManagerProviders()
Lists the Trust Manager Providers. |
|
java.lang.String[] |
listVirtualAttributes()
Lists the Virtual Attributes. |
|
java.lang.String[] |
listWorkflowElements()
Lists the Workflow Elements. |
|
java.lang.String[] |
listWorkflows()
Lists the Workflows. |
|
void |
removeAccountStatusNotificationHandler(java.lang.String name)
Removes the named Account Status Notification Handler. |
|
void |
removeAlertHandler(java.lang.String name)
Removes the named Alert Handler. |
|
void |
removeAttributeSyntax(java.lang.String name)
Removes the named Attribute Syntax. |
|
void |
removeBackend(java.lang.String name)
Removes the named Backend. |
|
void |
removeCertificateMapper(java.lang.String name)
Removes the named Certificate Mapper. |
|
void |
removeConnectionHandler(java.lang.String name)
Removes the named Connection Handler. |
|
void |
removeEntryCache(java.lang.String name)
Removes the named Entry Cache. |
|
void |
removeExtendedOperationHandler(java.lang.String name)
Removes the named Extended Operation Handler. |
|
void |
removeGroupImplementation(java.lang.String name)
Removes the named Group Implementation. |
|
void |
removeIdentityMapper(java.lang.String name)
Removes the named Identity Mapper. |
|
void |
removeKeyManagerProvider(java.lang.String name)
Removes the named Key Manager Provider. |
|
void |
removeLogPublisher(java.lang.String name)
Removes the named Log Publisher. |
|
void |
removeLogRetentionPolicy(java.lang.String name)
Removes the named Log Retention Policy. |
|
void |
removeLogRotationPolicy(java.lang.String name)
Removes the named Log Rotation Policy. |
|
void |
removeMatchingRule(java.lang.String name)
Removes the named Matching Rule. |
|
void |
removeMonitorProvider(java.lang.String name)
Removes the named Monitor Provider. |
|
void |
removeNetworkGroup(java.lang.String name)
Removes the named Network Group. |
|
void |
removePasswordGenerator(java.lang.String name)
Removes the named Password Generator. |
|
void |
removePasswordPolicy(java.lang.String name)
Removes the named Password Policy. |
|
void |
removePasswordStorageScheme(java.lang.String name)
Removes the named Password Storage Scheme. |
|
void |
removePasswordValidator(java.lang.String name)
Removes the named Password Validator. |
|
void |
removeSASLMechanismHandler(java.lang.String name)
Removes the named SASL Mechanism Handler. |
|
void |
removeSynchronizationProvider(java.lang.String name)
Removes the named Synchronization Provider. |
|
void |
removeTrustManagerProvider(java.lang.String name)
Removes the named Trust Manager Provider. |
|
void |
removeVirtualAttribute(java.lang.String name)
Removes the named Virtual Attribute. |
|
void |
removeWorkflow(java.lang.String name)
Removes the named Workflow. |
|
void |
removeWorkflowElement(java.lang.String name)
Removes the named Workflow Element. |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends RootCfgClient,? extends RootCfg> definition()
definition
in interface ConfigurationClient
AccessControlHandlerCfgClient getAccessControlHandler() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
DefinitionDecodingException
- If the Access Control Handler was found but its type
could not be determined.
ManagedObjectDecodingException
- If the Access Control Handler was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the Access Control Handler could not be found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the Access Control
Handler because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listAccountStatusNotificationHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Account Status
Notification Handlers because the client does not have
the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.AccountStatusNotificationHandlerCfgClient getAccountStatusNotificationHandler(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Account Status Notification Handler to
retrieve.
DefinitionDecodingException
- If the named Account Status Notification Handler was
found but its type could not be determined.
ManagedObjectDecodingException
- If the named Account Status Notification Handler was
found but one or more of its properties could not be
decoded.
ManagedObjectNotFoundException
- If the named Account Status Notification Handler was
not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Account
Status Notification Handler because the client does not
have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends AccountStatusNotificationHandlerCfgClient> C createAccountStatusNotificationHandler(ManagedObjectDefinition<C,? extends AccountStatusNotificationHandlerCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Account Status Notification Handler
being created.d
- The definition of the Account Status Notification
Handler to be created.name
- The name of the new Account Status Notification Handler.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Account
Status Notification Handler. This argument can be
null.
- Returns:
- Returns a new Account Status Notification Handler
configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Account Status Notification
Handler is invalid.
void removeAccountStatusNotificationHandler(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Account Status Notification Handler to
remove.
ManagedObjectNotFoundException
- If the Account Status Notification Handler does not
exist.
OperationRejectedException
- If the server refuses to remove the Account Status
Notification Handler due to some server-side constraint
which cannot be satisfied (for example, if it is
referenced by another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Account Status
Notification Handler because the client does not have
the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listAlertHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Alert Handlers
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.AlertHandlerCfgClient getAlertHandler(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Alert Handler to retrieve.
DefinitionDecodingException
- If the named Alert Handler was found but its type could
not be determined.
ManagedObjectDecodingException
- If the named Alert Handler was found but one or more of
its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Alert Handler was not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Alert
Handler because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends AlertHandlerCfgClient> C createAlertHandler(ManagedObjectDefinition<C,? extends AlertHandlerCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Alert Handler being created.d
- The definition of the Alert Handler to be created.name
- The name of the new Alert Handler.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Alert
Handler. This argument can be null.
- Returns:
- Returns a new Alert Handler configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Alert Handler is invalid.
void removeAlertHandler(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Alert Handler to remove.
ManagedObjectNotFoundException
- If the Alert Handler does not exist.
OperationRejectedException
- If the server refuses to remove the Alert Handler due
to some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Alert Handler
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listAttributeSyntaxes() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Attribute Syntaxes
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.AttributeSyntaxCfgClient getAttributeSyntax(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Attribute Syntax to retrieve.
DefinitionDecodingException
- If the named Attribute Syntax was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Attribute Syntax was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Attribute Syntax was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Attribute
Syntax because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends AttributeSyntaxCfgClient> C createAttributeSyntax(ManagedObjectDefinition<C,? extends AttributeSyntaxCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Attribute Syntax being created.d
- The definition of the Attribute Syntax to be created.name
- The name of the new Attribute Syntax.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Attribute Syntax. This argument can be null.
- Returns:
- Returns a new Attribute Syntax configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Attribute Syntax is invalid.
void removeAttributeSyntax(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Attribute Syntax to remove.
ManagedObjectNotFoundException
- If the Attribute Syntax does not exist.
OperationRejectedException
- If the server refuses to remove the Attribute Syntax
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Attribute Syntax
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listBackends() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Backends because the
client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.BackendCfgClient getBackend(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Backend to retrieve.
DefinitionDecodingException
- If the named Backend was found but its type could not
be determined.
ManagedObjectDecodingException
- If the named Backend was found but one or more of its
properties could not be decoded.
ManagedObjectNotFoundException
- If the named Backend was not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Backend
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends BackendCfgClient> C createBackend(ManagedObjectDefinition<C,? extends BackendCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Backend being created.d
- The definition of the Backend to be created.name
- The name of the new Backend.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Backend. This argument can be null.
- Returns:
- Returns a new Backend configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Backend is invalid.
void removeBackend(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Backend to remove.
ManagedObjectNotFoundException
- If the Backend does not exist.
OperationRejectedException
- If the server refuses to remove the Backend due to some
server-side constraint which cannot be satisfied (for
example, if it is referenced by another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Backend because the
client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listCertificateMappers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Certificate Mappers
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.CertificateMapperCfgClient getCertificateMapper(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Certificate Mapper to retrieve.
DefinitionDecodingException
- If the named Certificate Mapper was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Certificate Mapper was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Certificate Mapper was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Certificate
Mapper because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends CertificateMapperCfgClient> C createCertificateMapper(ManagedObjectDefinition<C,? extends CertificateMapperCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Certificate Mapper being created.d
- The definition of the Certificate Mapper to be created.name
- The name of the new Certificate Mapper.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Certificate Mapper. This argument can be
null.
- Returns:
- Returns a new Certificate Mapper configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Certificate Mapper is invalid.
void removeCertificateMapper(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Certificate Mapper to remove.
ManagedObjectNotFoundException
- If the Certificate Mapper does not exist.
OperationRejectedException
- If the server refuses to remove the Certificate Mapper
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Certificate Mapper
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listConnectionHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Connection Handlers
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.ConnectionHandlerCfgClient getConnectionHandler(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Connection Handler to retrieve.
DefinitionDecodingException
- If the named Connection Handler was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Connection Handler was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Connection Handler was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Connection
Handler because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends ConnectionHandlerCfgClient> C createConnectionHandler(ManagedObjectDefinition<C,? extends ConnectionHandlerCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Connection Handler being created.d
- The definition of the Connection Handler to be created.name
- The name of the new Connection Handler.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Connection Handler. This argument can be
null.
- Returns:
- Returns a new Connection Handler configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Connection Handler is invalid.
void removeConnectionHandler(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Connection Handler to remove.
ManagedObjectNotFoundException
- If the Connection Handler does not exist.
OperationRejectedException
- If the server refuses to remove the Connection Handler
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Connection Handler
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.CryptoManagerCfgClient getCryptoManager() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
DefinitionDecodingException
- If the Crypto Manager was found but its type could not
be determined.
ManagedObjectDecodingException
- If the Crypto Manager was found but one or more of its
properties could not be decoded.
ManagedObjectNotFoundException
- If the Crypto Manager could not be found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the Crypto Manager
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listEntryCaches() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Entry Caches because
the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.EntryCacheCfgClient getEntryCache(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Entry Cache to retrieve.
DefinitionDecodingException
- If the named Entry Cache was found but its type could
not be determined.
ManagedObjectDecodingException
- If the named Entry Cache was found but one or more of
its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Entry Cache was not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Entry Cache
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends EntryCacheCfgClient> C createEntryCache(ManagedObjectDefinition<C,? extends EntryCacheCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Entry Cache being created.d
- The definition of the Entry Cache to be created.name
- The name of the new Entry Cache.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Entry
Cache. This argument can be null.
- Returns:
- Returns a new Entry Cache configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Entry Cache is invalid.
void removeEntryCache(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Entry Cache to remove.
ManagedObjectNotFoundException
- If the Entry Cache does not exist.
OperationRejectedException
- If the server refuses to remove the Entry Cache due to
some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Entry Cache because
the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listExtendedOperationHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Extended Operation
Handlers because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.ExtendedOperationHandlerCfgClient getExtendedOperationHandler(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Extended Operation Handler to retrieve.
DefinitionDecodingException
- If the named Extended Operation Handler was found but
its type could not be determined.
ManagedObjectDecodingException
- If the named Extended Operation Handler was found but
one or more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Extended Operation Handler was not found
on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Extended
Operation Handler because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends ExtendedOperationHandlerCfgClient> C createExtendedOperationHandler(ManagedObjectDefinition<C,? extends ExtendedOperationHandlerCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Extended Operation Handler being
created.d
- The definition of the Extended Operation Handler to be
created.name
- The name of the new Extended Operation Handler.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Extended Operation Handler. This argument can be
null.
- Returns:
- Returns a new Extended Operation Handler configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Extended Operation Handler is
invalid.
void removeExtendedOperationHandler(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Extended Operation Handler to remove.
ManagedObjectNotFoundException
- If the Extended Operation Handler does not exist.
OperationRejectedException
- If the server refuses to remove the Extended Operation
Handler due to some server-side constraint which cannot
be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Extended Operation
Handler because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.GlobalCfgClient getGlobalConfiguration() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
DefinitionDecodingException
- If the Global Configuration was found but its type
could not be determined.
ManagedObjectDecodingException
- If the Global Configuration was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the Global Configuration could not be found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the Global
Configuration because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listGroupImplementations() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Group Implementations
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.GroupImplementationCfgClient getGroupImplementation(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Group Implementation to retrieve.
DefinitionDecodingException
- If the named Group Implementation was found but its
type could not be determined.
ManagedObjectDecodingException
- If the named Group Implementation was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Group Implementation was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Group
Implementation because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends GroupImplementationCfgClient> C createGroupImplementation(ManagedObjectDefinition<C,? extends GroupImplementationCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Group Implementation being created.d
- The definition of the Group Implementation to be
created.name
- The name of the new Group Implementation.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Group
Implementation. This argument can be null.
- Returns:
- Returns a new Group Implementation configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Group Implementation is invalid.
void removeGroupImplementation(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Group Implementation to remove.
ManagedObjectNotFoundException
- If the Group Implementation does not exist.
OperationRejectedException
- If the server refuses to remove the Group
Implementation due to some server-side constraint which
cannot be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Group
Implementation because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listIdentityMappers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Identity Mappers
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.IdentityMapperCfgClient getIdentityMapper(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Identity Mapper to retrieve.
DefinitionDecodingException
- If the named Identity Mapper was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Identity Mapper was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Identity Mapper was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Identity
Mapper because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends IdentityMapperCfgClient> C createIdentityMapper(ManagedObjectDefinition<C,? extends IdentityMapperCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Identity Mapper being created.d
- The definition of the Identity Mapper to be created.name
- The name of the new Identity Mapper.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Identity Mapper. This argument can be null.
- Returns:
- Returns a new Identity Mapper configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Identity Mapper is invalid.
void removeIdentityMapper(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Identity Mapper to remove.
ManagedObjectNotFoundException
- If the Identity Mapper does not exist.
OperationRejectedException
- If the server refuses to remove the Identity Mapper due
to some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Identity Mapper
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listKeyManagerProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Key Manager Providers
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.KeyManagerProviderCfgClient getKeyManagerProvider(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Key Manager Provider to retrieve.
DefinitionDecodingException
- If the named Key Manager Provider was found but its
type could not be determined.
ManagedObjectDecodingException
- If the named Key Manager Provider was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Key Manager Provider was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Key Manager
Provider because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends KeyManagerProviderCfgClient> C createKeyManagerProvider(ManagedObjectDefinition<C,? extends KeyManagerProviderCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Key Manager Provider being created.d
- The definition of the Key Manager Provider to be
created.name
- The name of the new Key Manager Provider.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Key
Manager Provider. This argument can be null.
- Returns:
- Returns a new Key Manager Provider configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Key Manager Provider is invalid.
void removeKeyManagerProvider(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Key Manager Provider to remove.
ManagedObjectNotFoundException
- If the Key Manager Provider does not exist.
OperationRejectedException
- If the server refuses to remove the Key Manager
Provider due to some server-side constraint which cannot
be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Key Manager
Provider because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listLogPublishers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Log Publishers
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.LogPublisherCfgClient getLogPublisher(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Log Publisher to retrieve.
DefinitionDecodingException
- If the named Log Publisher was found but its type could
not be determined.
ManagedObjectDecodingException
- If the named Log Publisher was found but one or more of
its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Log Publisher was not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Log
Publisher because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends LogPublisherCfgClient> C createLogPublisher(ManagedObjectDefinition<C,? extends LogPublisherCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Log Publisher being created.d
- The definition of the Log Publisher to be created.name
- The name of the new Log Publisher.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Log
Publisher. This argument can be null.
- Returns:
- Returns a new Log Publisher configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Log Publisher is invalid.
void removeLogPublisher(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Log Publisher to remove.
ManagedObjectNotFoundException
- If the Log Publisher does not exist.
OperationRejectedException
- If the server refuses to remove the Log Publisher due
to some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Log Publisher
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listLogRetentionPolicies() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Log Retention
Policies because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.LogRetentionPolicyCfgClient getLogRetentionPolicy(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Log Retention Policy to retrieve.
DefinitionDecodingException
- If the named Log Retention Policy was found but its
type could not be determined.
ManagedObjectDecodingException
- If the named Log Retention Policy was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Log Retention Policy was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Log
Retention Policy because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends LogRetentionPolicyCfgClient> C createLogRetentionPolicy(ManagedObjectDefinition<C,? extends LogRetentionPolicyCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Log Retention Policy being created.d
- The definition of the Log Retention Policy to be
created.name
- The name of the new Log Retention Policy.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Log
Retention Policy. This argument can be null.
- Returns:
- Returns a new Log Retention Policy configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Log Retention Policy is invalid.
void removeLogRetentionPolicy(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Log Retention Policy to remove.
ManagedObjectNotFoundException
- If the Log Retention Policy does not exist.
OperationRejectedException
- If the server refuses to remove the Log Retention
Policy due to some server-side constraint which cannot
be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Log Retention
Policy because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listLogRotationPolicies() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Log Rotation Policies
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.LogRotationPolicyCfgClient getLogRotationPolicy(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Log Rotation Policy to retrieve.
DefinitionDecodingException
- If the named Log Rotation Policy was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Log Rotation Policy was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Log Rotation Policy was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Log
Rotation Policy because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends LogRotationPolicyCfgClient> C createLogRotationPolicy(ManagedObjectDefinition<C,? extends LogRotationPolicyCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Log Rotation Policy being created.d
- The definition of the Log Rotation Policy to be created.name
- The name of the new Log Rotation Policy.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Log
Rotation Policy. This argument can be null.
- Returns:
- Returns a new Log Rotation Policy configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Log Rotation Policy is invalid.
void removeLogRotationPolicy(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Log Rotation Policy to remove.
ManagedObjectNotFoundException
- If the Log Rotation Policy does not exist.
OperationRejectedException
- If the server refuses to remove the Log Rotation Policy
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Log Rotation Policy
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listMatchingRules() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Matching Rules
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.MatchingRuleCfgClient getMatchingRule(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Matching Rule to retrieve.
DefinitionDecodingException
- If the named Matching Rule was found but its type could
not be determined.
ManagedObjectDecodingException
- If the named Matching Rule was found but one or more of
its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Matching Rule was not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Matching
Rule because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends MatchingRuleCfgClient> C createMatchingRule(ManagedObjectDefinition<C,? extends MatchingRuleCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Matching Rule being created.d
- The definition of the Matching Rule to be created.name
- The name of the new Matching Rule.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Matching Rule. This argument can be null.
- Returns:
- Returns a new Matching Rule configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Matching Rule is invalid.
void removeMatchingRule(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Matching Rule to remove.
ManagedObjectNotFoundException
- If the Matching Rule does not exist.
OperationRejectedException
- If the server refuses to remove the Matching Rule due
to some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Matching Rule
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listMonitorProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Monitor Providers
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.MonitorProviderCfgClient getMonitorProvider(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Monitor Provider to retrieve.
DefinitionDecodingException
- If the named Monitor Provider was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Monitor Provider was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Monitor Provider was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Monitor
Provider because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends MonitorProviderCfgClient> C createMonitorProvider(ManagedObjectDefinition<C,? extends MonitorProviderCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Monitor Provider being created.d
- The definition of the Monitor Provider to be created.name
- The name of the new Monitor Provider.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Monitor
Provider. This argument can be null.
- Returns:
- Returns a new Monitor Provider configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Monitor Provider is invalid.
void removeMonitorProvider(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Monitor Provider to remove.
ManagedObjectNotFoundException
- If the Monitor Provider does not exist.
OperationRejectedException
- If the server refuses to remove the Monitor Provider
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Monitor Provider
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listNetworkGroups() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Network Groups
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.NetworkGroupCfgClient getNetworkGroup(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Network Group to retrieve.
DefinitionDecodingException
- If the named Network Group was found but its type could
not be determined.
ManagedObjectDecodingException
- If the named Network Group was found but one or more of
its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Network Group was not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Network
Group because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends NetworkGroupCfgClient> C createNetworkGroup(ManagedObjectDefinition<C,? extends NetworkGroupCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Network Group being created.d
- The definition of the Network Group to be created.name
- The name of the new Network Group.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Network
Group. This argument can be null.
- Returns:
- Returns a new Network Group configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Network Group is invalid.
void removeNetworkGroup(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Network Group to remove.
ManagedObjectNotFoundException
- If the Network Group does not exist.
OperationRejectedException
- If the server refuses to remove the Network Group due
to some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Network Group
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listPasswordGenerators() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Password Generators
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.PasswordGeneratorCfgClient getPasswordGenerator(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Generator to retrieve.
DefinitionDecodingException
- If the named Password Generator was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Password Generator was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Password Generator was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Password
Generator because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends PasswordGeneratorCfgClient> C createPasswordGenerator(ManagedObjectDefinition<C,? extends PasswordGeneratorCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Password Generator being created.d
- The definition of the Password Generator to be created.name
- The name of the new Password Generator.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Password Generator. This argument can be
null.
- Returns:
- Returns a new Password Generator configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Password Generator is invalid.
void removePasswordGenerator(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Generator to remove.
ManagedObjectNotFoundException
- If the Password Generator does not exist.
OperationRejectedException
- If the server refuses to remove the Password Generator
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Password Generator
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listPasswordPolicies() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Password Policies
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.PasswordPolicyCfgClient getPasswordPolicy(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Policy to retrieve.
DefinitionDecodingException
- If the named Password Policy was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Password Policy was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Password Policy was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Password
Policy because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends PasswordPolicyCfgClient> C createPasswordPolicy(ManagedObjectDefinition<C,? extends PasswordPolicyCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Password Policy being created.d
- The definition of the Password Policy to be created.name
- The name of the new Password Policy.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Password Policy. This argument can be null.
- Returns:
- Returns a new Password Policy configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Password Policy is invalid.
void removePasswordPolicy(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Policy to remove.
ManagedObjectNotFoundException
- If the Password Policy does not exist.
OperationRejectedException
- If the server refuses to remove the Password Policy due
to some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Password Policy
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listPasswordStorageSchemes() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Password Storage
Schemes because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.PasswordStorageSchemeCfgClient getPasswordStorageScheme(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Storage Scheme to retrieve.
DefinitionDecodingException
- If the named Password Storage Scheme was found but its
type could not be determined.
ManagedObjectDecodingException
- If the named Password Storage Scheme was found but one
or more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Password Storage Scheme was not found on
the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Password
Storage Scheme because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends PasswordStorageSchemeCfgClient> C createPasswordStorageScheme(ManagedObjectDefinition<C,? extends PasswordStorageSchemeCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Password Storage Scheme being created.d
- The definition of the Password Storage Scheme to be
created.name
- The name of the new Password Storage Scheme.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Password Storage Scheme. This argument can be
null.
- Returns:
- Returns a new Password Storage Scheme configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Password Storage Scheme is
invalid.
void removePasswordStorageScheme(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Storage Scheme to remove.
ManagedObjectNotFoundException
- If the Password Storage Scheme does not exist.
OperationRejectedException
- If the server refuses to remove the Password Storage
Scheme due to some server-side constraint which cannot
be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Password Storage
Scheme because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listPasswordValidators() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Password Validators
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.PasswordValidatorCfgClient getPasswordValidator(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Validator to retrieve.
DefinitionDecodingException
- If the named Password Validator was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Password Validator was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Password Validator was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Password
Validator because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends PasswordValidatorCfgClient> C createPasswordValidator(ManagedObjectDefinition<C,? extends PasswordValidatorCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Password Validator being created.d
- The definition of the Password Validator to be created.name
- The name of the new Password Validator.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Password Validator. This argument can be
null.
- Returns:
- Returns a new Password Validator configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Password Validator is invalid.
void removePasswordValidator(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Password Validator to remove.
ManagedObjectNotFoundException
- If the Password Validator does not exist.
OperationRejectedException
- If the server refuses to remove the Password Validator
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Password Validator
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.PluginRootCfgClient getPluginRoot() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
DefinitionDecodingException
- If the Plugin Root was found but its type could not be
determined.
ManagedObjectDecodingException
- If the Plugin Root was found but one or more of its
properties could not be decoded.
ManagedObjectNotFoundException
- If the Plugin Root could not be found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the Plugin Root
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.RootDNCfgClient getRootDN() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
DefinitionDecodingException
- If the Root DN was found but its type could not be
determined.
ManagedObjectDecodingException
- If the Root DN was found but one or more of its
properties could not be decoded.
ManagedObjectNotFoundException
- If the Root DN could not be found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the Root DN because
the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.RootDSEBackendCfgClient getRootDSEBackend() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
DefinitionDecodingException
- If the Root DSE Backend was found but its type could
not be determined.
ManagedObjectDecodingException
- If the Root DSE Backend was found but one or more of
its properties could not be decoded.
ManagedObjectNotFoundException
- If the Root DSE Backend could not be found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the Root DSE Backend
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listSASLMechanismHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the SASL Mechanism
Handlers because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.SASLMechanismHandlerCfgClient getSASLMechanismHandler(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the SASL Mechanism Handler to retrieve.
DefinitionDecodingException
- If the named SASL Mechanism Handler was found but its
type could not be determined.
ManagedObjectDecodingException
- If the named SASL Mechanism Handler was found but one
or more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named SASL Mechanism Handler was not found on
the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named SASL
Mechanism Handler because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends SASLMechanismHandlerCfgClient> C createSASLMechanismHandler(ManagedObjectDefinition<C,? extends SASLMechanismHandlerCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the SASL Mechanism Handler being created.d
- The definition of the SASL Mechanism Handler to be
created.name
- The name of the new SASL Mechanism Handler.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the SASL
Mechanism Handler. This argument can be null.
- Returns:
- Returns a new SASL Mechanism Handler configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new SASL Mechanism Handler is
invalid.
void removeSASLMechanismHandler(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the SASL Mechanism Handler to remove.
ManagedObjectNotFoundException
- If the SASL Mechanism Handler does not exist.
OperationRejectedException
- If the server refuses to remove the SASL Mechanism
Handler due to some server-side constraint which cannot
be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the SASL Mechanism
Handler because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listSynchronizationProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Synchronization
Providers because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.SynchronizationProviderCfgClient getSynchronizationProvider(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Synchronization Provider to retrieve.
DefinitionDecodingException
- If the named Synchronization Provider was found but its
type could not be determined.
ManagedObjectDecodingException
- If the named Synchronization Provider was found but one
or more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Synchronization Provider was not found on
the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named
Synchronization Provider because the client does not
have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends SynchronizationProviderCfgClient> C createSynchronizationProvider(ManagedObjectDefinition<C,? extends SynchronizationProviderCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Synchronization Provider being created.d
- The definition of the Synchronization Provider to be
created.name
- The name of the new Synchronization Provider.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Synchronization Provider. This argument can be
null.
- Returns:
- Returns a new Synchronization Provider configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Synchronization Provider is
invalid.
void removeSynchronizationProvider(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Synchronization Provider to remove.
ManagedObjectNotFoundException
- If the Synchronization Provider does not exist.
OperationRejectedException
- If the server refuses to remove the Synchronization
Provider due to some server-side constraint which cannot
be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Synchronization
Provider because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listTrustManagerProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Trust Manager
Providers because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.TrustManagerProviderCfgClient getTrustManagerProvider(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Trust Manager Provider to retrieve.
DefinitionDecodingException
- If the named Trust Manager Provider was found but its
type could not be determined.
ManagedObjectDecodingException
- If the named Trust Manager Provider was found but one
or more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Trust Manager Provider was not found on
the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Trust
Manager Provider because the client does not have the
correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends TrustManagerProviderCfgClient> C createTrustManagerProvider(ManagedObjectDefinition<C,? extends TrustManagerProviderCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Trust Manager Provider being created.d
- The definition of the Trust Manager Provider to be
created.name
- The name of the new Trust Manager Provider.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Trust
Manager Provider. This argument can be null.
- Returns:
- Returns a new Trust Manager Provider configuration
instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Trust Manager Provider is
invalid.
void removeTrustManagerProvider(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Trust Manager Provider to remove.
ManagedObjectNotFoundException
- If the Trust Manager Provider does not exist.
OperationRejectedException
- If the server refuses to remove the Trust Manager
Provider due to some server-side constraint which cannot
be satisfied (for example, if it is referenced by
another managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Trust Manager
Provider because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listVirtualAttributes() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Virtual Attributes
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.VirtualAttributeCfgClient getVirtualAttribute(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Virtual Attribute to retrieve.
DefinitionDecodingException
- If the named Virtual Attribute was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Virtual Attribute was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Virtual Attribute was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Virtual
Attribute because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends VirtualAttributeCfgClient> C createVirtualAttribute(ManagedObjectDefinition<C,? extends VirtualAttributeCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Virtual Attribute being created.d
- The definition of the Virtual Attribute to be created.name
- The name of the new Virtual Attribute.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Virtual
Attribute. This argument can be null.
- Returns:
- Returns a new Virtual Attribute configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Virtual Attribute is invalid.
void removeVirtualAttribute(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Virtual Attribute to remove.
ManagedObjectNotFoundException
- If the Virtual Attribute does not exist.
OperationRejectedException
- If the server refuses to remove the Virtual Attribute
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Virtual Attribute
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listWorkflows() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Workflows because the
client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.WorkflowCfgClient getWorkflow(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Workflow to retrieve.
DefinitionDecodingException
- If the named Workflow was found but its type could not
be determined.
ManagedObjectDecodingException
- If the named Workflow was found but one or more of its
properties could not be decoded.
ManagedObjectNotFoundException
- If the named Workflow was not found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Workflow
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends WorkflowCfgClient> C createWorkflow(ManagedObjectDefinition<C,? extends WorkflowCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Workflow being created.d
- The definition of the Workflow to be created.name
- The name of the new Workflow.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Workflow. This argument can be null.
- Returns:
- Returns a new Workflow configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Workflow is invalid.
void removeWorkflow(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Workflow to remove.
ManagedObjectNotFoundException
- If the Workflow does not exist.
OperationRejectedException
- If the server refuses to remove the Workflow due to
some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Workflow because
the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listWorkflowElements() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to list the Workflow Elements
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.WorkflowElementCfgClient getWorkflowElement(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Workflow Element to retrieve.
DefinitionDecodingException
- If the named Workflow Element was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Workflow Element was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Workflow Element was not found on the
server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the named Workflow
Element because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends WorkflowElementCfgClient> C createWorkflowElement(ManagedObjectDefinition<C,? extends WorkflowElementCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Workflow Element being created.d
- The definition of the Workflow Element to be created.name
- The name of the new Workflow Element.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the
Workflow Element. This argument can be null.
- Returns:
- Returns a new Workflow Element configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Workflow Element is invalid.
void removeWorkflowElement(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Workflow Element to remove.
ManagedObjectNotFoundException
- If the Workflow Element does not exist.
OperationRejectedException
- If the server refuses to remove the Workflow Element
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to remove the Workflow Element
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.WorkQueueCfgClient getWorkQueue() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
DefinitionDecodingException
- If the Work Queue was found but its type could not be
determined.
ManagedObjectDecodingException
- If the Work Queue was found but one or more of its
properties could not be decoded.
ManagedObjectNotFoundException
- If the Work Queue could not be found on the server.
ConcurrentModificationException
- If this Root has been removed from the server by
another client.
AuthorizationException
- If the server refuses to retrieve the Work Queue
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |