Class FFDCResponseBase
java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
- All Implemented Interfaces:
FFDCResponse
- Direct Known Subclasses:
AccessServicesResponse
,ActorProfileResponse
,ActorProfilesResponse
,AdminServicesAPIResponse
,AnnotationResponse
,AnnotationsResponse
,APIOperationResponse
,APIOperationsResponse
,APIParameterListResponse
,APIParameterListsResponse
,APIParameterResponse
,APIParametersResponse
,APIResponse
,APIsResponse
,AppointeesResponse
,AssetCatalogOMASAPIResponse
,AssetElementResponse
,AssetElementsResponse
,AssetGraphResponse
,AssetManagerOMASAPIResponse
,AssetRelationshipsResponse
,AssetSearchMatchesListResponse
,BooleanResponse
,CertificationsResponse
,CertificationTypeResponse
,CertificationTypesResponse
,CollectionMemberResponse
,CollectionMembersResponse
,CollectionResponse
,CollectionsResponse
,CommentTypesResponse
,CommunitiesResponse
,CommunityProfileOMASAPIResponse
,CommunityResponse
,ConnectionListResponse
,ConnectionResponse
,ConnectionsResponse
,ConnectorReportResponse
,ConnectorTypeResponse
,ConnectorTypesResponse
,ControlFlowElementResponse
,ControlFlowElementsResponse
,CountResponse
,DatabaseColumnResponse
,DatabaseColumnsResponse
,DatabaseResponse
,DatabaseSchemaResponse
,DatabaseSchemasResponse
,DatabasesResponse
,DatabaseTableResponse
,DatabaseTablesResponse
,DatabaseViewResponse
,DatabaseViewsResponse
,DataContainerResponse
,DataContainersResponse
,DataFieldResponse
,DataFieldsResponse
,DataFileResponse
,DataFilesResponse
,DataFlowElementResponse
,DataFlowElementsResponse
,DataManagerOMASAPIResponse
,DataScienceOMASAPIResponse
,DesignModelOMASAPIResponse
,DigitalServiceResponse
,DigitalServicesResponse
,DuplicatesResponse
,ElementHeaderResponse
,ElementHeadersResponse
,ElementStubResponse
,ElementStubsResponse
,EndpointResponse
,EndpointsResponse
,EngineHostServicesResponse
,EventTypeResponse
,EventTypesResponse
,ExternalReferenceResponse
,ExternalReferencesResponse
,FileFolderResponse
,FileFoldersResponse
,FileSystemResponse
,FormResponse
,FormsResponse
,GlossaryTermListResponse
,GlossaryTermResponse
,GovernanceDefinitionGraphResponse
,GovernanceDefinitionResponse
,GovernanceDefinitionsResponse
,GovernanceDomainResponse
,GovernanceDomainSetResponse
,GovernanceDomainSetsResponse
,GovernanceDomainsResponse
,GovernanceEngineOMASAPIResponse
,GovernanceEngineSummariesResponse
,GovernanceEngineSummaryResponse
,GovernanceLevelIdentifierResponse
,GovernanceLevelIdentifierSetResponse
,GovernanceLevelIdentifierSetsResponse
,GovernanceLevelIdentifiersResponse
,GovernanceMetricImplementationsResponse
,GovernanceMetricResponse
,GovernanceMetricsResponse
,GovernanceRoleAppointeesResponse
,GovernanceRoleHistoryResponse
,GovernanceRoleResponse
,GovernanceRolesResponse
,GovernanceStatusIdentifierResponse
,GovernanceStatusIdentifierSetResponse
,GovernanceStatusIdentifierSetsResponse
,GovernanceZoneDefinitionResponse
,GovernanceZoneResponse
,GovernanceZonesResponse
,GUIDListResponse
,GUIDResponse
,HostResponse
,HostsResponse
,InformalTagResponse
,InformalTagsResponse
,IntegrationDaemonServicesResponse
,IntegrationDaemonStatusResponse
,IntegrationGroupsResponse
,IntegrationGroupSummariesResponse
,IntegrationGroupSummaryResponse
,IntegrationServicesResponse
,IntegrationServiceSummaryResponse
,ITInfrastructureOMASAPIResponse
,ITProfileResponse
,ITProfilesResponse
,LicensesResponse
,LicenseTypeResponse
,LicenseTypesResponse
,LineageMappingElementResponse
,LineageMappingElementsResponse
,LineageNodeNamesResponse
,LineageNodeNamesResponse
,LineageResponse
,LineageResponse
,LineageSearchResponse
,LineageSearchResponse
,LineageTypesResponse
,LineageTypesResponse
,LineageVertexResponse
,LineageVertexResponse
,LocationResponse
,LocationsResponse
,MeaningResponse
,MeaningsResponse
,MetadataElementSummariesResponse
,MetadataElementSummaryResponse
,MetadataRelationshipSummariesResponse
,MetadataSourceResponse
,NameListResponse
,OCFConnectionResponse
,OCFConnectorTypeResponse
,OCFConnectorTypesResponse
,OCFOMASAPIResponse
,OMAGGAFAPIResponse
,OMAGOIFAPIResponse
,OMAGServerStatusResponse
,PersonalProfileResponse
,PersonalProfilesResponse
,PersonRoleAppointeesResponse
,PersonRoleResponse
,PersonRolesResponse
,PlatformReportResponse
,PortElementResponse
,PortElementsResponse
,ProcessCallElementResponse
,ProcessCallElementsResponse
,ProcessElementResponse
,ProcessElementsResponse
,ProjectMemberResponse
,ProjectMembersResponse
,ProjectResponse
,ProjectsResponse
,PropertiesResponse
,QueriesResponse
,QueryResponse
,ReferenceValueAssignmentDefinitionsResponse
,ReferenceValueAssignmentItemsResponse
,RegisteredOMAGServicesResponse
,RelatedAssetsResponse
,RelatedElementsResponse
,RelatedMetadataElementSummariesResponse
,RelationshipElementResponse
,RelationshipElementsResponse
,ReportResponse
,ReportsResponse
,SchemaAttributeResponse
,SchemaAttributesResponse
,SchemaTypeElementResponse
,SchemaTypeElementsResponse
,SchemaTypeResponse
,SchemaTypesResponse
,SecurityGroupResponse
,SecurityGroupsResponse
,ServerAssetUseResponse
,ServerAssetUsesResponse
,ServerListResponse
,ServerReportResponse
,ServerServicesListResponse
,ServerStatusResponse
,SoftwareCapabilitiesResponse
,SoftwareCapabilityResponse
,SoftwareDeveloperOMASAPIResponse
,SoftwareServerPlatformResponse
,SoftwareServerPlatformsResponse
,SoftwareServerResponse
,SoftwareServersResponse
,StringMapResponse
,StringResponse
,SubjectAreaDefinitionResponse
,SubjectAreaResponse
,SubjectAreasResponse
,SuccessMessageResponse
,SupportedCapabilitiesResponse
,SurveyReportsResponse
,TechnologyTypeElementListResponse
,TechnologyTypeHierarchyResponse
,TechnologyTypeReportResponse
,TechnologyTypeSummaryListResponse
,TemplateElementResponse
,TemplateElementsResponse
,TermAssignmentStatusesResponse
,ToDoResponse
,ToDosResponse
,TopicResponse
,TopicsResponse
,UserIdentitiesResponse
,UserIdentityResponse
,ValidValueAssignmentConsumersResponse
,ValidValueAssignmentDefinitionsResponse
,ValidValueMappingsResponse
,ValidValueResponse
,ValidValueSetsResponse
,ValidValuesImplAssetsResponse
,ValidValuesImplDefinitionsResponse
,ValidValuesMappingsResponse
,ValidValuesResponse
,ViewServicesResponse
,VoidResponse
FFDCResponseBase provides the base class for REST API responses.
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorFFDCResponseBase
(FFDCResponseBase template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Return comparison result based on the content of the properties.Return the description of the action in progress when the exception occurred.Return the name of any nested exception that may indicate the root cause of the exception.Return the name of the Java class name to use to recreate the exception.Return the error message associated with the exception.Return the formal message identifier for the error message.String[]
Return the parameters that were inserted in the error message.Return the additional properties stored by the exceptions.Return the description of the action taken by the system as a result of the exception.Return the action that a user should take to resolve the problem.int
Return the HTTP Code to use if forwarding response to HTTP client.int
hashCode()
Return hash code for this objectvoid
setActionDescription
(String actionDescription) Set up the description of the activity in progress when the exception occurred.void
setExceptionCausedBy
(String exceptionCausedBy) Set up the name of any nested exception that may indicate the root cause of the exception.void
setExceptionClassName
(String exceptionClassName) Set up the name of the Java class name to use to recreate the exception.void
setExceptionErrorMessage
(String exceptionErrorMessage) Set up the error message associated with the exception.void
setExceptionErrorMessageId
(String exceptionErrorMessageId) Set up the formal message identifier for the error message.void
setExceptionErrorMessageParameters
(String[] exceptionErrorMessageParameters) Set up the list of parameters inserted in to the error message.void
setExceptionProperties
(Map<String, Object> exceptionProperties) Set up the additional properties stored by the exceptions.void
setExceptionSystemAction
(String exceptionSystemAction) Set up the description of the action taken by the system as a result of the exception.void
setExceptionUserAction
(String exceptionUserAction) Set up the action that a user should take to resolve the problem.void
setRelatedHTTPCode
(int relatedHTTPCode) Set up the HTTP Code to use if forwarding response to HTTP client.toString()
JSON-like toString
-
Constructor Details
-
FFDCResponseBase
public FFDCResponseBase()Default constructor -
FFDCResponseBase
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getExceptionClassName
Return the name of the Java class name to use to recreate the exception.- Specified by:
getExceptionClassName
in interfaceFFDCResponse
- Returns:
- String name of the fully-qualified java class name
-
setExceptionClassName
Set up the name of the Java class name to use to recreate the exception.- Specified by:
setExceptionClassName
in interfaceFFDCResponse
- Parameters:
exceptionClassName
- - String name of the fully-qualified java class name
-
getExceptionCausedBy
Return the name of any nested exception that may indicate the root cause of the exception.- Specified by:
getExceptionCausedBy
in interfaceFFDCResponse
- Returns:
- exception class name
-
setExceptionCausedBy
Set up the name of any nested exception that may indicate the root cause of the exception.- Specified by:
setExceptionCausedBy
in interfaceFFDCResponse
- Parameters:
exceptionCausedBy
- exception class name
-
getActionDescription
Return the description of the action in progress when the exception occurred.- Specified by:
getActionDescription
in interfaceFFDCResponse
- Returns:
- string description
-
setActionDescription
Set up the description of the activity in progress when the exception occurred.- Specified by:
setActionDescription
in interfaceFFDCResponse
- Parameters:
actionDescription
- string description
-
getRelatedHTTPCode
public int getRelatedHTTPCode()Return the HTTP Code to use if forwarding response to HTTP client.- Specified by:
getRelatedHTTPCode
in interfaceFFDCResponse
- Returns:
- integer HTTP status code
-
setRelatedHTTPCode
public void setRelatedHTTPCode(int relatedHTTPCode) Set up the HTTP Code to use if forwarding response to HTTP client.- Specified by:
setRelatedHTTPCode
in interfaceFFDCResponse
- Parameters:
relatedHTTPCode
- - integer HTTP status code
-
getExceptionErrorMessage
Return the error message associated with the exception.- Specified by:
getExceptionErrorMessage
in interfaceFFDCResponse
- Returns:
- string error message
-
setExceptionErrorMessage
Set up the error message associated with the exception.- Specified by:
setExceptionErrorMessage
in interfaceFFDCResponse
- Parameters:
exceptionErrorMessage
- - string error message
-
getExceptionErrorMessageId
Return the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.- Specified by:
getExceptionErrorMessageId
in interfaceFFDCResponse
- Returns:
- string identifier
-
setExceptionErrorMessageId
Set up the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.- Specified by:
setExceptionErrorMessageId
in interfaceFFDCResponse
- Parameters:
exceptionErrorMessageId
- string identifier
-
getExceptionErrorMessageParameters
Return the parameters that were inserted in the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.- Specified by:
getExceptionErrorMessageParameters
in interfaceFFDCResponse
- Returns:
- array of strings
-
setExceptionErrorMessageParameters
Set up the list of parameters inserted in to the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.- Specified by:
setExceptionErrorMessageParameters
in interfaceFFDCResponse
- Parameters:
exceptionErrorMessageParameters
- list of strings
-
getExceptionSystemAction
Return the description of the action taken by the system as a result of the exception.- Specified by:
getExceptionSystemAction
in interfaceFFDCResponse
- Returns:
- - string description of the action taken
-
setExceptionSystemAction
Set up the description of the action taken by the system as a result of the exception.- Specified by:
setExceptionSystemAction
in interfaceFFDCResponse
- Parameters:
exceptionSystemAction
- - string description of the action taken
-
getExceptionUserAction
Return the action that a user should take to resolve the problem.- Specified by:
getExceptionUserAction
in interfaceFFDCResponse
- Returns:
- string instructions
-
setExceptionUserAction
Set up the action that a user should take to resolve the problem.- Specified by:
setExceptionUserAction
in interfaceFFDCResponse
- Parameters:
exceptionUserAction
- - string instructions
-
getExceptionProperties
Return the additional properties stored by the exceptions.- Specified by:
getExceptionProperties
in interfaceFFDCResponse
- Returns:
- property map
-
setExceptionProperties
Set up the additional properties stored by the exceptions.- Specified by:
setExceptionProperties
in interfaceFFDCResponse
- Parameters:
exceptionProperties
- property map
-
toString
JSON-like toString -
equals
Return comparison result based on the content of the properties. -
hashCode
public int hashCode()Return hash code for this object
-