Package dm.soap.data

Class AuthenticatorInfo

  • All Implemented Interfaces:
    dm.soap.DmSoapConstants
    public class AuthenticatorInfo
extends dm.soap.services.DmSoapService
    This class holds all of the information about the authenticator it's constructed with.

    • Field Summary

      • Fields inherited from class dm.soap.services.DmSoapService

        GEN_TYPE_NATIVE, GEN_TYPE_RENDERED, GEN_TYPE_UNKNOWN

      • Fields inherited from interface dm.soap.DmSoapConstants

        PROP_CURRENT_USER, TECHDOC_REASON

    • Constructor Summary

      Constructors 
      Constructor Description
      AuthenticatorInfo()
      Creates a new instance of AuthenticatorInfo.
      AuthenticatorInfo​(dm.record.Authenticator auth)
      Creates a new instance of AuthenticatorInfo with the specified authenticator.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getID()
      Returns the ID for this authenticator.
      java.lang.String getName()
      Returns the name for this authenticator.
      java.lang.String getServiceData()
      Returns the service data for this authenticator.
      java.lang.String getServiceName()
      Returns the service name for this authenticator.

      • Methods inherited from class dm.soap.services.DmSoapService

        allowRender, calculateAccessToRemove, getActiveSessions, getAuthenticator, getAuthenticator, getAuthenticatorID, getAuthenticatorServiceID, getBoolean, getBoolean, getBooleanValue, getBooleanValue, getCommentID, getCurrentUser, getDisabled, getDisabledValue, getDocCategory, getDocCatID, getDocComment, getDocCommentIDs, getDocID, getDocType, getDocTypeID, getDocument, getDocument, getDocumentAccess, getDocumentInheritanceTypeID, getEmployer, getEmployerID, getEmployerString, getFetchAccess, getFetchAccessID, getFile, getFolder, getFolder, getFolder, getFolderAccess, getFolderInheritanceTypeID, getFolderReadAccess, getFullFolderPath, getGeneration, getGeneration, getGeneration, getGenerationType, getGroup, getGroup, getGroupMemberType, getGroupType, getIntValue, getKeyword, getKeywordDataType, getKeywordDataTypeString, getKeywordID, getKeywordInputType, getKeywordInputTypeString, getKeywordString, getMetricFrequency, getMetricOrg, getMetricOrgID, getMetricPerson, getMetricPersonID, getMetricStatusID, getMetricType, getMimeType, getMimeTypeID, getMimeTypeName, getNetworkAddress, getNetworkAddressType, getNetworkAddressType, getOrg, getOrgID, getOrgString, getReadAccess, getReadAccessString, getReason, getRemoteUser, getRemoteUser, getReview, getReviewTeam, getReviewTeamID, getRmaFilePlanID, getRmaFilePlanString, getRmaRecordSetID, getRmaRecordSetString, getSmHost, getSmHostWebSearchID, getSmHostWebSearchString, getSmSendID, getSmSendString, getUser, getUserFullName, getUserID, getUsername, getUserPrivs, getUserPrivsString, getWebSearchID, getWebSearchString, parseGenerationNumber

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AuthenticatorInfo

        public AuthenticatorInfo()
        Creates a new instance of AuthenticatorInfo.

      • AuthenticatorInfo

        public AuthenticatorInfo​(dm.record.Authenticator auth)
                  throws td.lang.TdException
        Creates a new instance of AuthenticatorInfo with the specified authenticator.
        Parameters:
        auth - The authenticator to use.
        Throws:
        td.lang.TdException - if an error occurs.

    • Method Detail

      • getID

        public int getID()
        Returns the ID for this authenticator.
        Returns:
        An int.

      • getName

        public java.lang.String getName()
        Returns the name for this authenticator.
        Returns:
        A String object.

      • getServiceData

        public java.lang.String getServiceData()
        Returns the service data for this authenticator.
        Returns:
        A String object.

      • getServiceName

        public java.lang.String getServiceName()
        Returns the service name for this authenticator.
        Returns:
        A String object.