Package dm.soap.services.searchmgrhost

Class DmSoapSearchMgrHost

java.lang.Object
dm.soap.services.DmSoapService
dm.soap.services.searchmgrhost.DmSoapSearchMgrHost
All Implemented Interfaces:
dm.soap.DmSoapConstants
Direct Known Subclasses:
DmSoapSamlSearchMgrHost
@MTOM(enabled=true, threshold=2048) @StreamingAttachment(parseEagerly=true, memoryThreshold=4000000L) public class DmSoapSearchMgrHost extends dm.soap.services.DmSoapService
This SOAP service is used to expose all Search Manager related TechDoc operations.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected jakarta.xml.ws.WebServiceContext
    _context
    The WebServiceContext that called this service.

    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
    DmSoapSearchMgrHost()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    createSearchMgrHost(SearchMgrHostInfo searchMgrInfo, String reason)
    Web service operation for the CreateSmHostCmd.
    void
    deleteSearchMgrHost(String hostName, String reason)
    Web service operation for the DeleteSmHostCmd.
    boolean
    exists(String hostName)
    Web service operation to see if the specified search manager host exists.
    void
    modifySearchMgrHost(String hostName, SearchMgrHostInfo newSearchMgrInfo, String reason)
    Web service operation for the ModifySmHostCmd.
    SearchMgrHostInfo
    showSearchMgrHost(String hostName)
    Web service operation for showing a specific search manager host specified by the host name.

    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

  • Field Details

    • _context

      protected jakarta.xml.ws.WebServiceContext _context
      The WebServiceContext that called this service.

  • Constructor Details

    • DmSoapSearchMgrHost

      public DmSoapSearchMgrHost()

  • Method Details

    • createSearchMgrHost

      public int createSearchMgrHost(SearchMgrHostInfo searchMgrInfo, String reason) throws DmSoapException
      Web service operation for the CreateSmHostCmd.
      Parameters:
      searchMgrInfo - A SearchMgrHostInfo object for the search manager host to create.
      reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.
      Returns:
      The unique ID of the search manager host created.
      Throws:
      DmSoapException - A DmSoapException if an error occurs.

    • deleteSearchMgrHost

      public void deleteSearchMgrHost(String hostName, String reason) throws DmSoapException
      Web service operation for the DeleteSmHostCmd.
      Parameters:
      hostName - The search manager host name.
      reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.
      Throws:
      DmSoapException - A DmSoapException if an error occurs.

    • exists

      public boolean exists(String hostName) throws DmSoapException
      Web service operation to see if the specified search manager host exists.
      Parameters:
      hostName - The host name of the search manager host.
      Returns:
      true if the SM host exists; false otherwise.
      Throws:
      DmSoapException - A DmSoapException if an error occurs.

    • modifySearchMgrHost

      public void modifySearchMgrHost(String hostName, SearchMgrHostInfo newSearchMgrInfo, String reason) throws DmSoapException
      Web service operation for the ModifySmHostCmd. Obtain the SearchMgrHostInfo object from showSearchMgrHost for the search manager host you want to modify. Change what you want, and call modifySearchMgrHost with the search manager host name and modified SearchMgrHostInfo object.
      Parameters:
      hostName - The host name of the existing search manager to modify.
      newSearchMgrInfo - A modified newSearchMgrInfo object for the search manager host specified.
      reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.
      Throws:
      DmSoapException - A DmSoapException if an error occurs.

    • showSearchMgrHost

      public SearchMgrHostInfo showSearchMgrHost(String hostName) throws DmSoapException
      Web service operation for showing a specific search manager host specified by the host name.
      Parameters:
      hostName - The host name of the search manager host.
      Returns:
      A SearchMgrHostInfo object, or null.
      Throws:
      DmSoapException - A DmSoapException if an error occurs.