Package com.arbortext.epic.cms

Interface CMSAdapter

All Known Implementing Classes:
CMSAdapterImpl
public interface CMSAdapter
Represents an installed content management system (CMS) adapter.
Since:
Epic 5.2

  • Method Summary

    Modifier and Type
    Method
    Description
    CMSSession
    connect(String loginId, String password, String dmsId)
    Establishes a content management system (CMS) session.
    Event
    createEvent(String eventType)
    Creates a CMS adapter event.
    int
    getAclId()
    Specifies the adapter ID associated with this CMSAdapter object.
    String
    getName()
    Specifies the human-readable name for this adapter.
    String
    getQualifiedName()
    Specifies the adapter qualified name associated with this adapter.
    String
    getUserData(String key)
    Retrieves application data from the adapter.
    boolean
    getValid()
    Indicates whether this adapter object is still valid.
    boolean
    hasFeature(String feature)
    Indicates whether this adapter implements a specified feature.No feature strings are currently defined.
    void
    setOldUserData(String data)
    Can be used to allow the connect method to work with older adapters ("Oracle iFS Adapter" or "Documentum Adapter").
    void
    setUserData(String key, String data)
    Stores some application data on the adapter.

  • Method Details

    • getName

      String getName()
      Specifies the human-readable name for this adapter.

    • getQualifiedName

      String getQualifiedName()
      Specifies the adapter qualified name associated with this adapter. Each adapter is guaranteed to have a unique qualified name.

    • getAclId

      int getAclId()
      Specifies the adapter ID associated with this CMSAdapter object. You can use this ID with the Arbortext Command Language (ACL) programming language such as with the sess_connect() function. However, such usage is discouraged because the appropriate AOM method should be used instead.

    • getValid

      boolean getValid()
      Indicates whether this adapter object is still valid. Some (older) adapters can get unloaded before application exit.

    • hasFeature

      boolean hasFeature(String feature) throws CMSException
      Indicates whether this adapter implements a specified feature.No feature strings are currently defined.
      Parameters:
      feature - Specifies the name of the feature.
      Returns:
      Returns true if the feature is supported. Returns false if it is not.
      Throws:
      CMSException - Raised for any error.

    • connect

      CMSSession connect(String loginId, String password, String dmsId) throws CMSException
      Establishes a content management system (CMS) session. On success, this session will become the "active" session. See the activeSession attribute of the Application interface for more details.
      Parameters:
      loginId - Specifies the CMS user name.
      password - Specifies the password for the loginId parameter.
      dmsId - Specifies the CMS-specific identifier for the repository domain, library, docbase, and so forth.
      Returns:
      A new CMS session.
      Throws:
      CMSException - Raised for any error.

    • createEvent

      Event createEvent(String eventType) throws AOMException
      Creates a CMS adapter event.
      Parameters:
      eventType - Specifies the type of Event interface to be created. The event modules supported by this method are CMSAdapterConnectEvent and CMSAdapterDisconnectEvent. If the Event is to be dispatched with the dispatchEvent method, the appropriate event init method must be called after creation in order to initialize the Event's values. As an example, a user wishing to synthesize a CMSAdapterPreConnect event would call createEvent with the parameter "CMSAdapterPreConnect". The initCMSAdapterConnectEvent method could then be called on the newly created CMSAdapterConnectEvent to set the specific type of CMSAdapterConnectEvent to be dispatched and to set its context information.
      Returns:
      The newly created Event
      Throws:
      AOMException - Raised if the implementation does not support the type of Event interface requested.
      Since:
      Arbortext 5.4

    • getUserData

      String getUserData(String key) throws CMSException
      Retrieves application data from the adapter. This method enables user interface or application code to retrieve named data that was previously stored by calling the setUserData method.
      Parameters:
      key - Specifies the unique key used to identify the data.
      Returns:
      The data associated with the given key, or null if there is none.
      Throws:
      CMSException - Raised for any error.

    • setUserData

      void setUserData(String key, String data) throws CMSException
      Stores some application data on the adapter. Any existing data for the same key is replaced by the new data. This method enables user interface or application code to associate named data with the adapter, which it can later retrieve by calling the getUserData method. User data is not saved between PTC Arbortext Editor or PTC Arbortext Publishing Engine sessions.
      Some adapters may support additional arguments to certain methods by having the application call setUserData with a predefined key just before calling the method. The adapter documentation will describe any such additional arguments.
      Parameters:
      key - Specifies the unique key used to identify the data.
      data - Specifies the data to associate with the given key, or null to remove any existing data for the key.
      Throws:
      CMSException - Raised for any error.

    • setOldUserData

      void setOldUserData(String data)
      Can be used to allow the connect method to work with older adapters ("Oracle iFS Adapter" or "Documentum Adapter"). Some older adapters require usage of a "user data" field while connecting.
      This stores the given data for use with the next call to the connect method. After that call, the stored data will be automatically erased so it won't affect future calls.This should only be used with older adapters and will have no effect on newer adapters.The data is stored directly with this AOM object. If this object is disposed before the method call, the data will not be available for use by the method. To avoid any issues, set the data immediately before making the method call.
      Parameters:
      data - Specifies the value to store as the old user data.