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

Class GovernanceProgramRESTClient

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.accessservices.governanceprogram.client.rest.GovernanceProgramRESTClient

public class GovernanceProgramRESTClient
extends FFDCRESTClient

RESTClient is responsible for issuing calls to the Governance Program OMAS REST APIs.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
CertificationTypeResponse	callCertificationTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a CertificationTypeResponse object.
CertificationTypesResponse	callCertificationTypeListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of CertificationTypeElement objects.
CertificationTypesResponse	callCertificationTypeListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of CertificationTypeElement objects.
GovernanceDefinitionResponse	callGovernanceDefinitionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDefinitionResponse object.
GovernanceDefinitionGraphResponse	callGovernanceDefinitionGraphGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDefinitionGraphResponse object.
GovernanceDefinitionsResponse	callGovernanceDefinitionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDefinitionsResponse object.
GovernanceDefinitionsResponse	callGovernanceDefinitionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceDefinitionsResponse objects.
GovernanceDomainResponse	callGovernanceDomainGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDomainResponse object.
GovernanceDomainsResponse	callGovernanceDomainListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceDomainsResponse objects.
GovernanceDomainsResponse	callGovernanceDomainListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceDomainsResponse objects.
GovernanceDomainSetResponse	callGovernanceDomainSetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDomainSetResponse object.
GovernanceDomainSetsResponse	callGovernanceDomainSetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDomainSetsResponse object.
GovernanceDomainSetsResponse	callGovernanceDomainSetListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceDomainSetsResponse objects.
GovernanceMetricResponse	callGovernanceMetricGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceMetricResponse object.
GovernanceMetricsResponse	callGovernanceMetricListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list ofGovernanceMetricElement objects.
GovernanceMetricImplementationsResponse	callGovernanceMetricsImplementationListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceMetricImplementationsResponse object.
GovernanceRoleAppointeesResponse	callGovernanceRoleAppointeeListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceRoleAppointee objects.
GovernanceRoleResponse	callGovernanceRoleGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceRoleResponse object.
GovernanceRoleHistoryResponse	callGovernanceRoleHistoryGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceRoleHistoryResponse object.
GovernanceRolesResponse	callGovernanceRoleListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceRoleElement objects.
GovernanceRolesResponse	callGovernanceRoleListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceRoleElement objects.
GovernanceZoneDefinitionResponse	callGovernanceZoneDefinitionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceZoneDefinitionResponse object.
GovernanceZoneResponse	callGovernanceZoneGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceZoneResponse object.
GovernanceZonesResponse	callGovernanceZoneListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceZonesResponse object.
GovernanceLevelIdentifierResponse	callLevelIdentifierGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceLevelIdentifierResponse object.
GovernanceLevelIdentifierResponse	callLevelIdentifierListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceLevelIdentifierResponse objects.
GovernanceLevelIdentifiersResponse	callLevelIdentifierListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceLevelIdentifiersResponse objects.
GovernanceLevelIdentifierSetResponse	callLevelIdentifierSetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceLevelIdentifierSetResponse object.
GovernanceLevelIdentifierSetsResponse	callLevelIdentifierSetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceLevelIdentifierSetsResponse objects.
GovernanceLevelIdentifierSetResponse	callLevelIdentifierSetListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceLevelIdentifierSetResponse objects.
LicenseTypeResponse	callLicenseTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a LicenseTypeResponse object.
LicenseTypesResponse	callLicenseTypesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of LicenseTypeElement objects.
RelatedElementsResponse	callRelatedElementsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RelatedElementsResponse object.
GovernanceStatusIdentifierResponse	callStatusIdentifierGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceStatusIdentifierResponse object.
GovernanceStatusIdentifierSetResponse	callStatusIdentifierSetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceStatusIdentifierSetResponse object.
GovernanceStatusIdentifierSetsResponse	callStatusIdentifierSetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceStatusIdentifierSetsResponse object.
SubjectAreaDefinitionResponse	callSubjectAreaDefinitionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SubjectAreaDefinitionResponse object.
SubjectAreaResponse	callSubjectAreaGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SubjectAreaResponse object.
SubjectAreasResponse	callSubjectAreaListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SubjectAreasResponse object.

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, callAssetElementsPostRESTCall, callAssetRelationshipsPostRESTCall, callBooleanGetRESTCall, 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, callLicenseTypeListPostRESTCall, callLineageMappingPostRESTCall, callLineageMappingsPostRESTCall, callLocationGetRESTCall, callLocationsGetRESTCall, callLocationsPostRESTCall, callMetadataElementSummariesPostRESTCall, callMetadataSourceGetRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callPersonRoleGetRESTCall, callPersonRolesGetRESTCall, callPersonRolesPostRESTCall, callProcessCallPostRESTCall, callProcessCallsPostRESTCall, callProjectGetRESTCall, callProjectsGetRESTCall, callProjectsPostRESTCall, callQueriesGetRESTCall, callQueriesPostRESTCall, callQueryGetRESTCall, callReferenceValueAssignmentDefinitionsGetRESTCall, callReferenceValueAssignmentItemsGetRESTCall, callRelatedAssetsPostRESTCall, 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

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                            throws InvalidParameterException

Constructor for no authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

auditLog - destination for log messages.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot)
                            throws InvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                            throws 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 platform 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:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password)
                            throws InvalidParameterException

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

callCertificationTypeGetRESTCall

public CertificationTypeResponse callCertificationTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a CertificationTypeResponse object.

Overrides:

callCertificationTypeGetRESTCall in class FFDCRESTClient

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

CertificationTypeResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callCertificationTypeListGetRESTCall

public CertificationTypesResponse callCertificationTypeListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of CertificationTypeElement objects.

Overrides:

callCertificationTypeListGetRESTCall in class FFDCRESTClient

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

CertificationTypesResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callCertificationTypeListPostRESTCall

public CertificationTypesResponse callCertificationTypeListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of CertificationTypeElement objects.

Overrides:

callCertificationTypeListPostRESTCall in class FFDCRESTClient

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

CertificationTypesResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionsPostRESTCall

public GovernanceDefinitionsResponse callGovernanceDefinitionsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceDefinitionsResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionsGetRESTCall

public GovernanceDefinitionsResponse callGovernanceDefinitionsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDefinitionsResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionGetRESTCall

public GovernanceDefinitionResponse callGovernanceDefinitionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDefinitionResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionGraphGetRESTCall

public GovernanceDefinitionGraphResponse callGovernanceDefinitionGraphGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDefinitionGraphResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionGraphResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceMetricsImplementationListGetRESTCall

public GovernanceMetricImplementationsResponse callGovernanceMetricsImplementationListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceMetricImplementationsResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionGraphResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainSetListPostRESTCall

public GovernanceDomainSetsResponse callGovernanceDomainSetListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceDomainSetsResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainSetsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainSetListGetRESTCall

public GovernanceDomainSetsResponse callGovernanceDomainSetListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDomainSetsResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainSetGetRESTCall

public GovernanceDomainSetResponse callGovernanceDomainSetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDomainSetResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainListPostRESTCall

public GovernanceDomainsResponse callGovernanceDomainListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceDomainsResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainListGetRESTCall

public GovernanceDomainsResponse callGovernanceDomainListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceDomainsResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainGetRESTCall

public GovernanceDomainResponse callGovernanceDomainGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDomainResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceMetricGetRESTCall

public GovernanceMetricResponse callGovernanceMetricGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceMetricResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceMetricResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceMetricListPostRESTCall

public GovernanceMetricsResponse callGovernanceMetricListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list ofGovernanceMetricElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceMetricsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLicenseTypeGetRESTCall

public LicenseTypeResponse callLicenseTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a LicenseTypeResponse object.

Overrides:

callLicenseTypeGetRESTCall in class FFDCRESTClient

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

LicenseTypeResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLicenseTypesGetRESTCall

public LicenseTypesResponse callLicenseTypesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of LicenseTypeElement objects.

Overrides:

callLicenseTypesGetRESTCall in class FFDCRESTClient

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

LicenseTypeListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callStatusIdentifierGetRESTCall

public GovernanceStatusIdentifierResponse callStatusIdentifierGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceStatusIdentifierResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceStatusIdentifierResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierGetRESTCall

public GovernanceLevelIdentifierResponse callLevelIdentifierGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceLevelIdentifierResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callStatusIdentifierSetGetRESTCall

public GovernanceStatusIdentifierSetResponse callStatusIdentifierSetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceStatusIdentifierSetResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceStatusIdentifierSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callStatusIdentifierSetListGetRESTCall

public GovernanceStatusIdentifierSetsResponse callStatusIdentifierSetListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceStatusIdentifierSetsResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceStatusIdentifierSetsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierListGetRESTCall

public GovernanceLevelIdentifierResponse callLevelIdentifierListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceLevelIdentifierResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierListPostRESTCall

public GovernanceLevelIdentifiersResponse callLevelIdentifierListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceLevelIdentifiersResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifiersResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierSetGetRESTCall

public GovernanceLevelIdentifierSetResponse callLevelIdentifierSetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceLevelIdentifierSetResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierSetListGetRESTCall

public GovernanceLevelIdentifierSetsResponse callLevelIdentifierSetListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceLevelIdentifierSetsResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierSetsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierSetListPostRESTCall

public GovernanceLevelIdentifierSetResponse callLevelIdentifierSetListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceLevelIdentifierSetResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleGetRESTCall

public GovernanceRoleResponse callGovernanceRoleGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceRoleResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleHistoryGetRESTCall

public GovernanceRoleHistoryResponse callGovernanceRoleHistoryGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceRoleHistoryResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleHistoryResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleListGetRESTCall

public GovernanceRolesResponse callGovernanceRoleListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceRoleElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRolesResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleListPostRESTCall

public GovernanceRolesResponse callGovernanceRoleListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceRoleElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRolesResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleAppointeeListGetRESTCall

public GovernanceRoleAppointeesResponse callGovernanceRoleAppointeeListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceRoleAppointee objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleAppointeesResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceZoneGetRESTCall

public GovernanceZoneResponse callGovernanceZoneGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceZoneResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

GovernanceZoneResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceZoneListGetRESTCall

public GovernanceZonesResponse callGovernanceZoneListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceZonesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

GovernanceZonesResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceZoneDefinitionGetRESTCall

public GovernanceZoneDefinitionResponse callGovernanceZoneDefinitionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceZoneDefinitionResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

GovernanceZoneDefinitionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callSubjectAreaGetRESTCall

public SubjectAreaResponse callSubjectAreaGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SubjectAreaResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

SubjectAreaResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callSubjectAreaDefinitionGetRESTCall

public SubjectAreaDefinitionResponse callSubjectAreaDefinitionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SubjectAreaDefinitionResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

SubjectAreaDefinitionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callSubjectAreaListGetRESTCall

public SubjectAreasResponse callSubjectAreaListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SubjectAreasResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

SubjectAreasResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callRelatedElementsGetRESTCall

public RelatedElementsResponse callRelatedElementsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RelatedElementsResponse object.

Overrides:

callRelatedElementsGetRESTCall in class FFDCRESTClient

Parameters:

methodName - name of the method being called.

urlTemplate - REST API call URL template with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.