Package org.forgerock.opendj.config
Interface ConfigurationClient
- All Known Subinterfaces:
AccessControlHandlerCfgClient
,AccessLogFilteringCriteriaCfgClient
,AccessLogPublisherCfgClient
,AccountStatusNotificationHandlerCfgClient
,AdminDataTrustManagerProviderCfgClient
,AdminEndpointCfgClient
,AdministrationConnectorCfgClient
,AesPasswordStorageSchemeCfgClient
,AlertHandlerCfgClient
,AliveEndpointCfgClient
,AnonymousSaslMechanismHandlerCfgClient
,Argon2PasswordStorageSchemeCfgClient
,AttributeCleanupPluginCfgClient
,AttributeValuePasswordValidatorCfgClient
,AuthenticationPolicyCfgClient
,BackendCfgClient
,BackendIndexCfgClient
,BackendVlvIndexCfgClient
,Base64PasswordStorageSchemeCfgClient
,BcryptPasswordStorageSchemeCfgClient
,BlindTrustManagerProviderCfgClient
,BlowfishPasswordStorageSchemeCfgClient
,CancelExtendedOperationHandlerCfgClient
,CertificateMapperCfgClient
,ChangeNumberControlPluginCfgClient
,CharacterSetPasswordValidatorCfgClient
,ClearPasswordStorageSchemeCfgClient
,CollectiveAttributeSubentriesVirtualAttributeCfgClient
,CommonAuditAccessLogPublisherCfgClient
,ConnectionHandlerCfgClient
,ConsoleErrorLogPublisherCfgClient
,CoreSchemaCfgClient
,CramMd5SaslMechanismHandlerCfgClient
,CrestMetricsEndpointCfgClient
,CryptoManagerCfgClient
,CryptPasswordStorageSchemeCfgClient
,CsvFileAccessLogPublisherCfgClient
,CsvFileHttpAccessLogPublisherCfgClient
,DictionaryPasswordValidatorCfgClient
,DigestMd5SaslMechanismHandlerCfgClient
,DseeCompatAccessControlHandlerCfgClient
,EntityTagPluginCfgClient
,EntityTagVirtualAttributeCfgClient
,EntryCacheCfgClient
,EntryDnVirtualAttributeCfgClient
,EntryUuidPluginCfgClient
,EntryUuidVirtualAttributeCfgClient
,ErrorLogAccountStatusNotificationHandlerCfgClient
,ErrorLogPublisherCfgClient
,ExactMatchIdentityMapperCfgClient
,ExtendedOperationHandlerCfgClient
,ExternalAccessLogPublisherCfgClient
,ExternalHttpAccessLogPublisherCfgClient
,ExternalSaslMechanismHandlerCfgClient
,FifoEntryCacheCfgClient
,FileBasedAccessLogPublisherCfgClient
,FileBasedAuditLogPublisherCfgClient
,FileBasedErrorLogPublisherCfgClient
,FileBasedHttpAccessLogPublisherCfgClient
,FileBasedKeyManagerProviderCfgClient
,FileBasedTrustManagerProviderCfgClient
,FileCountLogRetentionPolicyCfgClient
,FingerprintCertificateMapperCfgClient
,FixedTimeLogRotationPolicyCfgClient
,FractionalLdifImportPluginCfgClient
,FreeDiskSpaceLogRetentionPolicyCfgClient
,GetConnectionIdExtendedOperationHandlerCfgClient
,GetSymmetricKeyExtendedOperationHandlerCfgClient
,GlobalAccessControlPolicyCfgClient
,GlobalCfgClient
,GoverningStructureRuleVirtualAttributeCfgClient
,GraphiteMonitorReporterPluginCfgClient
,GssapiSaslMechanismHandlerCfgClient
,HasSubordinatesVirtualAttributeCfgClient
,HdapAuthorizationMechanismCfgClient
,HdapEndpointCfgClient
,HealthyEndpointCfgClient
,HttpAccessLogPublisherCfgClient
,HttpAnonymousAuthorizationMechanismCfgClient
,HttpAuthorizationMechanismCfgClient
,HttpBasicAuthorizationMechanismCfgClient
,HttpConnectionHandlerCfgClient
,HttpEndpointCfgClient
,HttpOauth2AuthorizationMechanismCfgClient
,HttpOauth2CtsAuthorizationMechanismCfgClient
,HttpOauth2FileAuthorizationMechanismCfgClient
,HttpOauth2OpenamAuthorizationMechanismCfgClient
,HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient
,IdentityMapperCfgClient
,IsMemberOfVirtualAttributeCfgClient
,JeBackendCfgClient
,JmxAlertHandlerCfgClient
,JmxConnectionHandlerCfgClient
,JsonEqualityMatchingRuleCfgClient
,JsonFileAccessLogPublisherCfgClient
,JsonFileHttpAccessLogPublisherCfgClient
,JsonOrderingMatchingRuleCfgClient
,JsonQueryEqualityMatchingRuleCfgClient
,KeyManagerProviderCfgClient
,LastModPluginCfgClient
,LdapAttributeDescriptionListPluginCfgClient
,LdapConnectionHandlerCfgClient
,LdapKeyManagerProviderCfgClient
,LdapPassThroughAuthenticationPolicyCfgClient
,LdapTrustManagerProviderCfgClient
,LdifBackendCfgClient
,LdifConnectionHandlerCfgClient
,LengthBasedPasswordValidatorCfgClient
,LocalBackendCfgClient
,LogPublisherCfgClient
,LogRetentionPolicyCfgClient
,LogRotationPolicyCfgClient
,MailServerCfgClient
,Md5PasswordStorageSchemeCfgClient
,MemberVirtualAttributeCfgClient
,MemoryBackendCfgClient
,MonitorBackendCfgClient
,NameAndJsonQueryEqualityMatchingRuleCfgClient
,NullBackendCfgClient
,NumSubordinatesVirtualAttributeCfgClient
,PasswordExpirationTimeVirtualAttributeCfgClient
,PasswordGeneratorCfgClient
,PasswordModifyExtendedOperationHandlerCfgClient
,PasswordPolicyCfgClient
,PasswordPolicyImportPluginCfgClient
,PasswordPolicyStateExtendedOperationHandlerCfgClient
,PasswordPolicySubentryVirtualAttributeCfgClient
,PasswordStorageSchemeCfgClient
,PasswordValidatorCfgClient
,Pbkdf2HmacSha256PasswordStorageSchemeCfgClient
,Pbkdf2HmacSha512PasswordStorageSchemeCfgClient
,Pbkdf2PasswordStorageSchemeCfgClient
,PemKeyManagerProviderCfgClient
,PemTrustManagerProviderCfgClient
,Pkcs11KeyManagerProviderCfgClient
,Pkcs11TrustManagerProviderCfgClient
,Pkcs5s2PasswordStorageSchemeCfgClient
,PlainSaslMechanismHandlerCfgClient
,PluggableBackendCfgClient
,PluginCfgClient
,PluginRootCfgClient
,PolicyBasedAccessControlHandlerCfgClient
,PrometheusEndpointCfgClient
,ProxyBackendCfgClient
,RandomPasswordGeneratorCfgClient
,Rc4PasswordStorageSchemeCfgClient
,ReferentialIntegrityPluginCfgClient
,RegularExpressionIdentityMapperCfgClient
,RepeatedCharactersPasswordValidatorCfgClient
,ReplicationDomainCfgClient
,ReplicationServerCfgClient
,ReplicationServiceDiscoveryMechanismCfgClient
,ReplicationSynchronizationProviderCfgClient
,Rest2ldapEndpointCfgClient
,RootCfgClient
,RootDseBackendCfgClient
,SaltedMd5PasswordStorageSchemeCfgClient
,SaltedSha1PasswordStorageSchemeCfgClient
,SaltedSha256PasswordStorageSchemeCfgClient
,SaltedSha384PasswordStorageSchemeCfgClient
,SaltedSha512PasswordStorageSchemeCfgClient
,SambaPasswordPluginCfgClient
,SaslMechanismHandlerCfgClient
,SchemaBackendCfgClient
,SchemaProviderCfgClient
,ScramSha256PasswordStorageSchemeCfgClient
,ScramSha256SaslMechanismHandlerCfgClient
,ScramSha512PasswordStorageSchemeCfgClient
,ScramSha512SaslMechanismHandlerCfgClient
,ServiceDiscoveryMechanismCfgClient
,SevenBitCleanPluginCfgClient
,Sha1PasswordStorageSchemeCfgClient
,SimilarityBasedPasswordValidatorCfgClient
,SizeLimitLogRetentionPolicyCfgClient
,SizeLimitLogRotationPolicyCfgClient
,SmtpAccountStatusNotificationHandlerCfgClient
,SmtpAlertHandlerCfgClient
,SoftReferenceEntryCacheCfgClient
,StartTlsExtendedOperationHandlerCfgClient
,StaticServiceDiscoveryMechanismCfgClient
,StructuralObjectClassVirtualAttributeCfgClient
,SubjectAttributeToUserAttributeCertificateMapperCfgClient
,SubjectDnToUserAttributeCertificateMapperCfgClient
,SubjectEqualsDnCertificateMapperCfgClient
,SubschemaSubentryVirtualAttributeCfgClient
,SynchronizationProviderCfgClient
,TaskBackendCfgClient
,TimeLimitLogRotationPolicyCfgClient
,TraditionalWorkQueueCfgClient
,TripleDesPasswordStorageSchemeCfgClient
,TrustManagerProviderCfgClient
,UniqueAttributePluginCfgClient
,UniqueCharactersPasswordValidatorCfgClient
,UserDefinedVirtualAttributeCfgClient
,UserTemplateVirtualAttributeCfgClient
,VirtualAttributeCfgClient
,WhoAmIExtendedOperationHandlerCfgClient
,WorkQueueCfgClient
public interface ConfigurationClient
A common base interface for all managed object configuration clients.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
commit()
If this is a new configuration this method will attempt to add it to the server, otherwise it will commit any changes made to this configuration.ManagedObjectDefinition<? extends ConfigurationClient,
? extends Configuration> Get the configuration definition associated with this configuration.Get a property provider view of this configuration.
-
Method Details
-
definition
ManagedObjectDefinition<? extends ConfigurationClient,? extends Configuration> definition()Get the configuration definition associated with this configuration.- Returns:
- Returns the configuration definition associated with this configuration.
-
properties
PropertyProvider properties()Get a property provider view of this configuration.- Returns:
- Returns a property provider view of this configuration.
-
commit
void commit() throws ManagedObjectAlreadyExistsException, MissingMandatoryPropertiesException, ConcurrentModificationException, OperationRejectedException, LdapExceptionIf this is a new configuration this method will attempt to add it to the server, otherwise it will commit any changes made to this configuration.- Throws:
ManagedObjectAlreadyExistsException
- If this is a new configuration but it could not be added to the server because it already exists.MissingMandatoryPropertiesException
- If this configuration contains some mandatory properties which have been left undefined.ConcurrentModificationException
- If this is a new configuration which is being added to the server but its parent has been removed by another client, or if this configuration is being modified but it has been removed from the server by another client.OperationRejectedException
- If the server refuses to add or modify this configuration due to some server-side constraint which cannot be satisfied.LdapException
- If any other error occurs.
-