T
- The configuration class that will be provided to initialize the handler.@PublicAPI(stability=VOLATILE, mayExtend=true) public abstract class ExtendedOperationHandler<T extends ExtendedOperationHandlerCfg> extends Object
Constructor and Description |
---|
ExtendedOperationHandler()
Builds an extended operation.
|
ExtendedOperationHandler(Set<String> supportedControlOIDs)
Builds an extended operation.
|
Modifier and Type | Method and Description |
---|---|
void |
finalizeExtendedOperationHandler()
Performs any finalization that may be necessary for this extended operation handler.
|
String |
getExtendedOperationName()
Retrieves the name associated with this extended operation.
|
String |
getExtendedOperationOID()
Retrieves the object OID associated with this extended operation.
|
Set<String> |
getSupportedControls()
Retrieves the OIDs of the controls that may be supported by this extended operation handler.
|
Set<String> |
getSupportedFeatures()
Retrieves the OIDs of the features that may be supported by this extended operation handler.
|
void |
initializeExtendedOperationHandler(T config)
Initializes this extended operation handler based on the information in the provided configuration entry.
|
boolean |
isConfigurationAcceptable(T configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this extended operation handler.
|
abstract void |
processExtendedOperation(ExtendedOperation operation)
Processes the provided extended operation.
|
boolean |
supportsControl(String controlOID)
Indicates whether this extended operation handler supports the specified control.
|
public ExtendedOperationHandler()
public void initializeExtendedOperationHandler(T config) throws ConfigException, InitializationException
config
- The extended operation handler configuration that contains the information to use to initialize this
extended operation handler.ConfigException
- If an unrecoverable problem arises in the process of performing the initialization.InitializationException
- If a problem occurs during initialization that is not related to the server configuration.public boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
configuration
- The extended operation handler configuration for which to make the determination.unacceptableReasons
- A list that may be used to hold the reasons that the provided configuration is not acceptable.true
if the provided configuration is acceptable for this extended operation handler, or
false
if not.public void finalizeExtendedOperationHandler()
public abstract void processExtendedOperation(ExtendedOperation operation)
operation
- The extended operation to be processed.public Set<String> getSupportedControls()
public final boolean supportsControl(String controlOID)
controlOID
- The OID of the control for which to make the determination.true
if this extended operation handler does support the requested control, or false
if
not.public Set<String> getSupportedFeatures()
public String getExtendedOperationName()
null
if there is none.public String getExtendedOperationOID()
null
if there is none.Copyright 2010-2022 ForgeRock AS.