|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.broker.api.PolicyInformationProvider
@Extensible @IdentityBrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class PolicyInformationProvider
This class defines an API that must be implemented by Identity Broker extensions that retrieve XACML attributes as part of the Policy Information Point (PIP).
dsconfig create-policy-information-provider \ --provider-name "{name}" \ --type third-party \ --set enabled:true \ --set "extension-class:{class-name}" \ --set "extension-argument:{name=value}" \ --set "xacml-attribute-id:{attributeId} \ --set "evaluation-order-index:{index}where "{name}" is the name to use for the policy information provider instance, "{class-name}" is the fully-qualified name of the Java class that extends
com.unboundid.directory.sdk.broker.api.PolicyInformationProvider
,
"{index}" is an integer from 1 to 9999 that is used to determine the
position of this Policy Information Provider in the order of evaluation
among all Policy Information Providers, "{attributeId}" identifies
the XACML attribute(s) that this provider knows how to retrieve, and
"{name=value}" represents name-value pairs for any additional
arguments to provide to the Policy Information Provider. If multiple
arguments should be provided to extension, then the
"--set extension-argument:{name=value}
" option should be
provided multiple times. If the Policy Information Provider can retrieve
more than one attribute type, then the
"--set xacml-attribute-id:{attributeId}
" option can also
be provided multiple times.
Constructor Summary | |
---|---|
PolicyInformationProvider()
|
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(PolicyInformationProviderConfig config,
com.unboundid.util.args.ArgumentParser parser,
java.util.List<java.lang.String> adminActionsRequired,
java.util.List<java.lang.String> messages)
Attempts to apply the configuration from the provided argument parser to this extension. |
void |
defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
Updates the provided argument parser to define any configuration arguments which may be used by this extension. |
void |
finalizePolicyInformationProvider()
Performs any cleanup which may be necessary when this policy information provider is to be taken out of service. |
abstract RequestAttribute |
getAttribute(java.lang.String categoryId,
java.lang.String attributeId,
RequestContext context)
Retrieve an attribute that has been requested by the policy engine. |
java.util.Map<java.util.List<java.lang.String>,java.lang.String> |
getExamplesArgumentSets()
Retrieves a map containing examples of configurations that may be used for this extension. |
abstract java.lang.String[] |
getExtensionDescription()
Retrieves a human-readable description for this extension. |
abstract java.lang.String |
getExtensionName()
Retrieves a human-readable name for this extension. |
void |
initializePolicyInformationProvider(IdentityBrokerContext serverContext,
PolicyInformationProviderConfig config,
com.unboundid.util.args.ArgumentParser parser)
Initializes this policy information provider. |
boolean |
isConfigurationAcceptable(PolicyInformationProviderConfig config,
com.unboundid.util.args.ArgumentParser parser,
java.util.List<java.lang.String> unacceptableReasons)
Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PolicyInformationProvider()
Method Detail |
---|
public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializePolicyInformationProvider(IdentityBrokerContext serverContext, PolicyInformationProviderConfig config, com.unboundid.util.args.ArgumentParser parser) throws java.lang.Exception
serverContext
- A handle to the server context for the server in
which this extension is running.config
- The general configuration for this policy
information provider.parser
- The argument parser which has been initialized from
the configuration for this policy information
provider.
java.lang.Exception
- If a problem occurs while initializing this
policy information provider.public boolean isConfigurationAcceptable(PolicyInformationProviderConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<PolicyInformationProviderConfig>
config
- The general configuration for this extension.parser
- The argument parser that has been used to
parse the proposed configuration for this
extension.unacceptableReasons
- A list to which messages may be added to
provide additional information about why the
provided configuration is not acceptable.
true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public com.unboundid.ldap.sdk.ResultCode applyConfiguration(PolicyInformationProviderConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<PolicyInformationProviderConfig>
config
- The general configuration for this extension.parser
- The argument parser that has been used to
parse the new configuration for this
extension.adminActionsRequired
- A list to which messages may be added to
provide additional information about any
additional administrative actions that may
be required to apply some of the
configuration changes.messages
- A list to which messages may be added to
provide additional information about the
processing performed by this method.
SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizePolicyInformationProvider()
public abstract RequestAttribute getAttribute(java.lang.String categoryId, java.lang.String attributeId, RequestContext context) throws java.lang.Exception
categoryId
- XACML category identifier. This is the category Id
specified by the AttributeDesignator element in the
policy that is requesting this attribute.attributeId
- XACML attribute identifier. This will be one of the
identifiers specified by the xacml-attribute-id
property of the configuration for this Policy
Information Provider.context
- request context, can be used to retrieve other
attributes from the request that may be needed
in order to evaluate the requested attribute
java.lang.Exception
- if an error occurs retrieving the attributepublic java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |