com.adobe.livecycle.rightsmanagement.client
Class RightsManagementClient

java.lang.Object
  extended by com.adobe.livecycle.rightsmanagement.client.RightsManagementClient
Direct Known Subclasses:
RightsManagementClient2

public class RightsManagementClient
extends java.lang.Object

Enables you to create Java objects that can invoke operations supported by the Rights Management service. Using a RightsManagementClient object, you can create the following objects:

For information, see Protecting Documents With Policies in Programming with Adobe Experience Manager Forms.


Field Summary
static java.lang.String MODE_PROPERTY_NAME
          The constant that represents the property used to specify the mode used to establish a connection with the Rights Management service.
static java.lang.String URL_PROPERTY_NAME
          The constant that represents the property used to specify the URL when establishing a connection to the Rights Management service.
 
Constructor Summary
RightsManagementClient(ServiceClientFactory serviceClientFactory)
          A constructor that creates a RightsManagementClient object.
 
Method Summary
 AbstractPolicyManager getAbstractPolicyManager()
          Creates a new policy manager.
 java.lang.String getClientVersion()
          Retrieves the version of the client-side Rights Management SDK components.
 DocumentManager getDocumentManager()
          Creates a new document manager.
 EventManager getEventManager()
          Creates a new event manager.
 ExternalUserManager getExternalUserManager()
          Creates a new external user manager.
 LicenseManager getLicenseManager()
          Creates a new license manager.
 PolicyManager getPolicyManager()
          Creates a new policy manager.
 WatermarkManager getWatermarkManager()
          Creates a new watermark manager.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

URL_PROPERTY_NAME

public static final java.lang.String URL_PROPERTY_NAME
The constant that represents the property used to specify the URL when establishing a connection to the Rights Management service. A value for this property is required only if soap mode is used. If ejb mode is used, the address of the server must be specified in a jndi.properties file.

See Also:
Constant Field Values

MODE_PROPERTY_NAME

public static final java.lang.String MODE_PROPERTY_NAME
The constant that represents the property used to specify the mode used to establish a connection with the Rights Management service. Note: Associated values for this property can be either "soap" or "ejb".

See Also:
Constant Field Values
Constructor Detail

RightsManagementClient

public RightsManagementClient(ServiceClientFactory serviceClientFactory)
A constructor that creates a RightsManagementClient object.

Parameters:
serviceClientFactory - A ServiceClientFactory object that contains connection settings.
Method Detail

getDocumentManager

public DocumentManager getDocumentManager()
Creates a new document manager.

Returns:
A new DocumentManager object.
See Also:
DocumentManager

getLicenseManager

public LicenseManager getLicenseManager()
Creates a new license manager.

Returns:
A new LicenseManager object.
See Also:
LicenseManager

getWatermarkManager

public WatermarkManager getWatermarkManager()
Creates a new watermark manager.

Returns:
A new WatermarkManager object.
See Also:
WatermarkManager

getPolicyManager

public PolicyManager getPolicyManager()
Creates a new policy manager.

Returns:
A new PolicyManager object.
See Also:
PolicyManager

getAbstractPolicyManager

public AbstractPolicyManager getAbstractPolicyManager()
Creates a new policy manager.

Returns:
A new PolicyManager object.
See Also:
AbstractPolicyManager

getExternalUserManager

public ExternalUserManager getExternalUserManager()
Creates a new external user manager.

Returns:
A new ExternalUserManager object.
See Also:
ExternalUserManager

getEventManager

public EventManager getEventManager()
Creates a new event manager.

Returns:
A new EventManager object.
See Also:
EventManager

getClientVersion

public java.lang.String getClientVersion()
Retrieves the version of the client-side Rights Management SDK components. This method is useful when comparing the version of the server-side SDK components and the client-side SDK components to determine if they are compatible.

Returns:
A String that contains the version of the client-side SDK components.