Package com.sas.lsaf.content.repository.signature

Class Signature

java.lang.Object
com.sas.lsaf.content.repository.signature.Signature
All Implemented Interfaces:
Serializable
public class Signature extends Object implements Serializable
The client-side representation of a signature.
Since:
1.7
See Also:

  • Constructor Details

    • Signature

      public Signature(String id, String repositoryFileId, String repositoryFilePath, String repositoryFileVersion, String userId, String role, String reason, String comment, Date timestamp, String signature)
      It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the user descriptors returned by the API.

      Note: Signatures are identifier-based, which means that a Signature is linked to the identifier of the RepositoryFile object. The path is specified here as a convenience, but the information is transient. For instance, if the RepositoryFile is moved, the identifier is the same, but the path changes.

      Parameters:
      id - The unique identifier of the signature.
      repositoryFileId - The unique identifier of the repository file associated with the signature.
      repositoryFilePath - The path to the repository file that is associated with the signature.
      repositoryFileVersion - The version of the repository file that is associated with the signature.
      userId - The identifier of the user who created the signature.
      role - The role that was used to create the signature.
      reason - The reason that was used to create the signature.
      comment - The comment specified with the signature.
      timestamp - The Date on which the signature was created.
      signature - The signature value that was generated when the signature was created.

  • Method Details

    • getId

      public String getId()
      Gets the unique identifier of the signature. The identifier is generated by the system when the signature is created.
      Returns:
      The identifier of the signature.

    • getRepositoryFileId

      public String getRepositoryFileId()
      Gets the unique identifier of the repository file that is associated with the signature.
      Returns:
      The identifier of the repository file that is associated with the signature.
      See Also:

    • getRepositoryFilePath

      public String getRepositoryFilePath()
      Gets the path to the repository file that is associated with the signature.

      Note: Signatures are based on an identifier, which means that a Signature is linked to the identifier of the RepositoryFile object. The path is specified here as a convenience, but the information is transient. For instance, if the RepositoryFile is moved, the identifier is the same, but the path changes.

      Returns:
      The path to the repository file that is associated with the signature.
      See Also:

    • getRepositoryFileVersion

      public String getRepositoryFileVersion()
      Gets the version of the repository file that is associated with the signature. This value is null, if the file is not versioned.
      Returns:
      The version of the repository file that is associated with the signature.

    • getUserId

      public String getUserId()
      Returns the identifier of the user who created the signature.
      Returns:
      The idenfier of the user who created the signature.

    • getRole

      public String getRole()
      Gets the role that was specified to create the signature.
      Returns:
      The role that was specified to create the signature.
      See Also:

    • getReason

      public String getReason()
      Gets the reason that was specified to create the signature.
      Returns:
      The reason specified to create the signature.
      See Also:

    • getComment

      public String getComment()
      Gets the comment that was specified with the signature, if one was specified.
      Returns:
      The comment that is associated with the signature.
      See Also:

    • getTimestamp

      public Date getTimestamp()
      Gets the date on which the signature was created.
      Returns:
      The date and time on which the signature was created.

    • getSignature

      public String getSignature()
      Gets the hash that was generated when the signature was created.
      Returns:
      The signature value that was generated when the file was signed.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object