Package org.odpi.openmetadata.accessservices.itinfrastructure.client.rest

Class ITInfrastructureRESTClient

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient
org.odpi.openmetadata.accessservices.itinfrastructure.client.rest.ITInfrastructureRESTClient
public class ITInfrastructureRESTClient extends org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient
ITInfrastructureRESTClient is responsible for issuing calls to the OMAS REST APIs.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot)
    Constructor for no authentication.
    ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Constructor for simple userId and password authentication.
    ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Constructor for simple userId and password authentication with audit log.
    ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Constructor for no authentication with audit log.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.AssetElementsResponse
    callAssetElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a POST REST call that returns a list of AssetElements in a response object.
    org.odpi.openmetadata.commonservices.ffdc.rest.AssetElementResponse
    callAssetGetRESTCall(String methodName, String urlTemplate, Object... params)
    Issue a GET REST call that returns an AssetElement in a response object.
    org.odpi.openmetadata.commonservices.ffdc.rest.AssetElementResponse
    callAssetPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)
    Issue a POST REST call that returns an asset in a response object.

    Methods inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient

    callOCFAssetGetRESTCall, callOCFAssetsGetRESTCall, callOCFAssetsPostRESTCall, callOCFConnectionGetRESTCall, callOCFTagGetRESTCall, callOCFTagListGetRESTCall, callOCFTagListPostRESTCall

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

    callActorProfileGetRESTCall, callActorProfilesGetRESTCall, callActorProfilesPostRESTCall, callAnnotationGetRESTCall, callAnnotationListGetRESTCall, callAnnotationListPostRESTCall, callAnnotationPostRESTCall, callAPIGetRESTCall, callAPIOperationGetRESTCall, callAPIOperationsGetRESTCall, callAPIOperationsPostRESTCall, callAPIParameterListGetRESTCall, callAPIParameterListsGetRESTCall, callAPIParameterListsPostRESTCall, callAPIParametersGetRESTCall, callAPIsGetRESTCall, callAPIsPostRESTCall, callAppointeesPostRESTCall, callAssetElementGetRESTCall, callAssetElementsGetRESTCall, callAssetRelationshipsPostRESTCall, callBooleanGetRESTCall, callCertificationTypeGetRESTCall, callCertificationTypeListGetRESTCall, callCertificationTypeListPostRESTCall, callCollectionGetRESTCall, callCollectionListGetRESTCall, callCollectionListPostRESTCall, callCollectionMemberGetRESTCall, callCollectionMemberListGetRESTCall, callCommunitiesGetRESTCall, callCommunitiesPostRESTCall, callCommunityGetRESTCall, callConnectionGetRESTCall, callConnectionsGetRESTCall, callConnectionsPostRESTCall, callConnectorTypeGetRESTCall, callConnectorTypesPostRESTCall, callControlFlowPostRESTCall, callControlFlowsPostRESTCall, callCountGetRESTCall, callDatabaseColumnGetRESTCall, callDatabaseColumnsGetRESTCall, callDatabaseColumnsPostRESTCall, callDatabaseGetRESTCall, callDatabaseSchemaGetRESTCall, callDatabaseSchemasGetRESTCall, callDatabaseSchemasPostRESTCall, callDatabasesPostRESTCall, callDatabaseTableGetRESTCall, callDatabaseTablesGetRESTCall, callDatabaseTablesPostRESTCall, callDatabaseViewGetRESTCall, callDatabaseViewsGetRESTCall, callDatabaseViewsPostRESTCall, callDataContainerGetRESTCall, callDataContainersGetRESTCall, callDataContainersPostRESTCall, callDataFileGetRESTCall, callDataFilePostRESTCall, callDataFilesGetRESTCall, callDataFilesPostRESTCall, callDataFlowPostRESTCall, callDataFlowsPostRESTCall, callDigitalServiceGetRESTCall, callDigitalServicesGetRESTCall, callDigitalServicesPostRESTCall, callDiscoveryAnalysisReportListPostRESTCall, callElementHeaderPostRESTCall, callElementHeadersPostRESTCall, callElementStubGetRESTCall, callElementStubsGetRESTCall, callElementStubsPostRESTCall, callEndpointGetRESTCall, callEndpointsGetRESTCall, callEndpointsPostRESTCall, callEventTypeGetRESTCall, callEventTypesGetRESTCall, callEventTypesPostRESTCall, callExternalReferenceGetRESTCall, callExternalReferencesGetRESTCall, callExternalReferencesPostRESTCall, callFileFolderGetRESTCall, callFileFolderPostRESTCall, callFileFoldersGetRESTCall, callFileSystemGetRESTCall, callFolderGetRESTCall, callFormGetRESTCall, callFormsGetRESTCall, callFormsPostRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callITProfileGetRESTCall, callITProfileListGetRESTCall, callITProfileListPostRESTCall, callLicensesGetRESTCall, callLicenseTypeGetRESTCall, callLicenseTypeListPostRESTCall, callLicenseTypesGetRESTCall, callLineageMappingPostRESTCall, callLineageMappingsPostRESTCall, callLocationGetRESTCall, callLocationsGetRESTCall, callLocationsPostRESTCall, callMetadataElementSummariesPostRESTCall, callMetadataSourceGetRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callPersonRoleGetRESTCall, callPersonRolesGetRESTCall, callPersonRolesPostRESTCall, callProcessCallPostRESTCall, callProcessCallsPostRESTCall, callProjectGetRESTCall, callProjectsGetRESTCall, callProjectsPostRESTCall, callQueriesGetRESTCall, callQueriesPostRESTCall, callQueryGetRESTCall, callReferenceValueAssignmentDefinitionsGetRESTCall, callReferenceValueAssignmentItemsGetRESTCall, callRelatedAssetsPostRESTCall, callRelatedElementsGetRESTCall, callRelatedElementsPostRESTCall, callRelationshipPostRESTCall, callRelationshipsPostRESTCall, callReportGetRESTCall, callReportsGetRESTCall, callReportsPostRESTCall, callSchemaAttributeGetRESTCall, callSchemaAttributePostRESTCall, callSchemaAttributesGetRESTCall, callSchemaAttributesPostRESTCall, callSchemaTypeGetRESTCall, callSchemaTypePostRESTCall, callSchemaTypesPostRESTCall, callSecurityGroupGetRESTCall, callSecurityGroupPostRESTCall, callSecurityGroupsGetRESTCall, callSecurityGroupsPostRESTCall, callServerAssetUseGetRESTCall, callServerAssetUseListGetRESTCall, callServerAssetUseListPostRESTCall, callSoftwareServerCapabilitiesGetRESTCall, callSoftwareServerCapabilitiesPostRESTCall, callSoftwareServerCapabilityGetRESTCall, callStringMapGetRESTCall, callSupportedCapabilityListPostRESTCall, callSurveyReportListGetRESTCall, callTopicGetRESTCall, callTopicsGetRESTCall, callTopicsPostRESTCall, callUserIdentitiesGetRESTCall, callUserIdentitiesPostRESTCall, callUserIdentityGetRESTCall, callUserIdentityListPostRESTCall, callUserIdentityPostRESTCall, callValidValueAssignmentConsumersGetRESTCall, callValidValueAssignmentDefinitionsGetRESTCall, callValidValueGetRESTCall, callValidValueListGetRESTCall, callValidValueListPostRESTCall, callValidValueMappingsGetRESTCall, callValidValueSetsPostRESTCall, callValidValuesGetRESTCall, callValidValuesImplAssetsGetRESTCall, callValidValuesImplDefinitionsGetRESTCall, callValidValuesMappingsGetRESTCall, callValidValuesPostRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

    callPostRESTCallNoParams

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ITInfrastructureRESTClient

      public ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Constructor for no authentication with audit log.
      Parameters:
      serverName - name of the OMAG Server to call
      serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
      auditLog - destination for log messages.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ITInfrastructureRESTClient

      public ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Constructor for no authentication.
      Parameters:
      serverName - name of the OMAG Server to call
      serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ITInfrastructureRESTClient

      public ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Constructor for simple userId and password authentication with audit log.
      Parameters:
      serverName - name of the OMAG Server to call
      serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
      userId - user id for the HTTP request
      password - password for the HTTP request
      auditLog - destination for log messages.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ITInfrastructureRESTClient

      public ITInfrastructureRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Constructor for simple userId and password authentication.
      Parameters:
      serverName - name of the OMAG Server to call
      serverPlatformURLRoot - URL root of the server manager where the OMAG Server is running.
      userId - user id for the HTTP request
      password - password for the HTTP request
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • callAssetGetRESTCall

      public org.odpi.openmetadata.commonservices.ffdc.rest.AssetElementResponse callAssetGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Issue a GET REST call that returns an AssetElement in a response object.
      Parameters:
      methodName - name of the method being called.
      urlTemplate - template of the URL for the REST API call with place-holders for the parameters.
      params - a list of parameters that are slotted into the url template.
      Returns:
      response object
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - something went wrong with the REST call stack.

    • callAssetPostRESTCall

      public org.odpi.openmetadata.commonservices.ffdc.rest.AssetElementResponse callAssetPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Issue a POST REST call that returns an asset in a response object.
      Parameters:
      methodName - name of the method being called
      urlTemplate - template of the URL for the REST API call with place-holders for the parameters
      requestBody - request body for the request
      params - a list of parameters that are slotted into the url template
      Returns:
      response object
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - something went wrong with the REST call stack.

    • callAssetElementsPostRESTCall

      public org.odpi.openmetadata.commonservices.ffdc.rest.AssetElementsResponse callAssetElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Issue a POST REST call that returns a list of AssetElements in a response object.
      Overrides:
      callAssetElementsPostRESTCall in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
      Parameters:
      methodName - name of the method being called
      urlTemplate - template of the URL for the REST API call with place-holders for the parameters
      requestBody - request body for the request
      params - a list of parameters that are slotted into the url template
      Returns:
      response objects
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to make this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - something went wrong with the REST call stack.