com.adobe.edc.server.spi.authorization
Interface ExternalAuthorizer

public interface ExternalAuthorizer

The ExternalAuthorizer interface is implemented to create a custom mechanism that allows external systems to participate and evaluate policy permissions. Third-party applications that need to provide functionality to evaluate the permissions based on their permission model will implement this interface as part of a DSC and register it. During the evaluation of a policy at runtime, if the policy requires external authorization, the Rights Management service will call the evaluate() method and pass all the information as part of the ExternalAuthDTO object. The returned value will be processed by the Rights Management service, and the result will be used to return the final outcome to the client.

Field Summary

static java.lang.String

SPECIFICATION_ID Specification identifier property.

Method Summary

ExternalAuthResultDTO	evaluate(ExternalAuthDTO authDto) Retrieves the evaluation result from external authorization systems.
ExternalAuthPropertyDTO[]	getProviderProperties() Retrieves a list of custom properties and values implemented by the external authorizer.

Field Detail

SPECIFICATION_ID

static final java.lang.String SPECIFICATION_ID

Specification identifier property. This identifier is used in component.xml. The Rights Management service queries the container to find out all the implementations for this interface.

See Also:

Constant Field Values

Method Detail

evaluate

ExternalAuthResultDTO evaluate(ExternalAuthDTO authDto)

Retrieves the evaluation result from external authorization systems. External authorization systems implement this interface and the Rights Management service prepares the details about the operation type, user context, license identifier, policy identifier and other policy-related properties, and sends them as part of the authDto parameter. The external authorization system can query ExternalAuthDTO to extract the relevant information

Parameters:

authDto - This object is created and intialized by the Rights Managment service and contains information about the user, policy, license, and other details.

Returns:

The evaluation result from the external authorization systems.

getProviderProperties

ExternalAuthPropertyDTO[] getProviderProperties()

Retrieves a list of custom properties and values implemented by the external authorizer. The Rights Management service calls this method on external authorization systems during policy creation time and displays the value in the user interface, as well as saving it as part of the policy.

Returns:

A list of custom properties and values.