B C D E F G H I L N O P R S T U V

B

BooleanRequestBody - Class in org.odpi.openmetadata.commonservices.ffdc.rest

BooleanRequestBody is the request body structure used on OMAG REST API calls that passed a boolean flag.

BooleanRequestBody() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanRequestBody

Default constructor

BooleanRequestBody(BooleanRequestBody) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanRequestBody

Copy/clone constructor

BooleanResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

BooleanResponse is the response structure used on OMAG REST API calls that return a boolean response.

BooleanResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse

Default constructor

BooleanResponse(BooleanResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse

Copy/clone constructor

C

callCountGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a GET REST call that returns a CountResponse object.

callGetRESTCall(String, Class<T>, String, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Issue a GET REST call that returns a response object.

callGetRESTCallNoParams(String, Class<T>, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Issue a GET REST call that returns a response object.

callGUIDGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a GET REST call that returns a GUIDResponse object.

callGUIDListGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a GET REST call that returns a list of GUIDs object.

callGUIDListPostRESTCall(String, String, Object, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a POST REST call that returns a list of GUIDs object.

callGUIDPostRESTCall(String, String, Object, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a POST REST call that returns a guid object.

callNameListGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a GET REST call that returns a list of names.

callPostRESTCall(String, Class<T>, String, Object, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Issue a POST REST call that returns a response object.

callPostRESTCallNoParams(String, Class<T>, String, Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Issue a POST REST call that returns a response object.

callStringMapGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a GET REST call that returns a list of names mapped to their descriptions.

callVoidGetRESTCall(String, String, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a POST REST call that returns a VoidResponse object.

callVoidPostRESTCall(String, String, Object, Object...) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Issue a POST REST call that returns a VoidResponse object.

captureCheckedException(FFDCResponseBase, OCFCheckedExceptionBase, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

captureCheckedException(FFDCResponseBase, OCFCheckedExceptionBase, String, Map<String, Object>) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

captureInvalidParameterException(FFDCResponseBase, InvalidParameterException) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

capturePropertyServerException(FFDCResponseBase, PropertyServerException) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

captureRepositoryErrorException(FFDCResponseBase, RepositoryErrorException) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

captureThrowable(FFDCResponseBase, Throwable, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

captureThrowable(FFDCResponseBase, Throwable, String, OMRSAuditLog) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

captureUserNotAuthorizedException(FFDCResponseBase, UserNotAuthorizedException) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Set the exception information into the response.

CountResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

CountResponse defines the response structure for the OMAS REST API calls that returns a number as a response.

CountResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.CountResponse

Default constructor

CountResponse(CountResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.CountResponse

Copy/clone constructor

D

detectAndThrowInvalidParameterException(String, FFDCResponseBase) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Throw an InvalidParameterException if it is encoded in the REST response.

detectAndThrowPropertyServerException(String, FFDCResponseBase) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Throw a PropertyServerException if it is encoded in the REST response.

detectAndThrowStandardExceptions(String, FFDCResponseBase) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Throw an exception if it is encoded in the REST response.

detectAndThrowUserNotAuthorizedException(String, FFDCResponseBase) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Throw an UserNotAuthorizedException if it is encoded in the REST response.

E

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanRequestBody

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.CountResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse

Return comparison result based on the content of the properties.

exceptionHandler - Variable in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

F

FFDCResponseBase - Class in org.odpi.openmetadata.commonservices.ffdc.rest

FFDCResponseBase() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Default constructor

FFDCResponseBase(FFDCResponseBase) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Copy/clone constructor

FFDCRESTClient - Class in org.odpi.openmetadata.commonservices.ffdc.rest

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

FFDCRESTClient(String, String) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Constructor for no authentication.

FFDCRESTClient(String, String, String, String) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

Constructor for simple userId and password authentication.

FFDCRESTClientBase - Class in org.odpi.openmetadata.commonservices.ffdc.rest

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

FFDCRESTClientBase(String, String) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Constructor for no authentication.

FFDCRESTClientBase(String, String, String, String) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

Constructor for simple userId and password authentication.

G

getCount() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.CountResponse

Return the count of objects.

getErrorMessageId() - Method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

Returns the unique identifier for the error message.

getExceptionClassName() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return the name of the Java class name to use to recreate the exception.

getExceptionErrorMessage() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return the error message associated with the exception.

getExceptionProperties() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return the additional properties stored by the exceptions.

getExceptionSystemAction() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return the description of the action taken by the system as a result of the exception.

getExceptionUserAction() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return the action that a user should take to resolve the problem.

getFormattedErrorMessage(String...) - Method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

Returns the error message with the placeholders filled out with the supplied parameters.

getFormattedLogMessage(String...) - Method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

Returns the log message with the placeholders filled out with the supplied parameters.

getGUID() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse

Return the guid result.

getGUIDs() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse

Return the guids result.

getHTTPErrorCode() - Method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

getLogMessageId() - Method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

Returns the unique identifier for the error message.

getMaxPagingSize() - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Get the maximum paging size.

getNames() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse

Return the name list result.

getRelatedHTTPCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return the HTTP Code to use if forwarding response to HTTP client.

getResultString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse

Return the guid result.

getServiceDescription() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Return the default description for this service.

getServiceName() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Return the default name for this service.

getServices() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse

Return the list of services

getServiceURLMarker() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Return the string that appears in the REST API URL that identifies the owning service.

getServiceWiki() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Return the URL for the wiki page describing this service.

getSeverity() - Method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

Return the severity of the audit log record.

getStringMap() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

Return the name list result.

getSystemAction() - Method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

Returns a description of the action taken by the system when the condition that caused this exception was detected.

getSystemAction() - Method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

Returns a description of the action taken by the system when the condition that caused this exception was detected.

getUnformattedErrorMessage() - Method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

Returns the error message with placeholders for specific details.

getUserAction() - Method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

Returns instructions of how to resolve the issue reported in this exception.

getUserAction() - Method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

Returns instructions of how to resolve the issue reported in this exception.

GUIDListResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

GUIDListResponse is the response structure used on the OMAS REST API calls that return a list of unique identifiers (guids) as a response.

GUIDListResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse

Default constructor

GUIDListResponse(GUIDListResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse

Copy/clone constructor

GUIDResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.

GUIDResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse

Default constructor

GUIDResponse(GUIDResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse

Copy/clone constructor

H

handleNoRequestBody(String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Manage an unexpected exception

handleUnexpectedException(Throwable, String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Manage an unexpected exception

handleWrongTypeForGUIDException(String, String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Throw an exception if the supplied guid returned an entity of the wrong type

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanRequestBody

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.CountResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse

Return hash code for this object

I

InvalidParameterException - Exception in org.odpi.openmetadata.commonservices.ffdc.exceptions

The InvalidParameterException is thrown by the OMAG Service when a parameter is null or an invalid value.

InvalidParameterException(int, String, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException

This is the typical constructor used for creating an exception.

InvalidParameterException(int, String, String, String, String, String, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException

This is the typical constructor used for creating an exception.

InvalidParameterException(int, String, String, String, String, String, Throwable, String) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException

This is the constructor used for creating an exception that resulted from a previous error.

InvalidParameterException(int, String, String, String, String, String, Throwable, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException

This is the constructor used for creating an exception that resulted from a previous error.

InvalidParameterException(String, InvalidParameterException) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException

This is the copy/clone constructor used for creating an exception.

InvalidParameterException(String, ConnectionCheckedException, String) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException

This is the copy/clone constructor used for creating an exception.

InvalidParameterHandler - Class in org.odpi.openmetadata.commonservices.ffdc

InvalidParameterHandler is a common error handler.

InvalidParameterHandler() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Default constructor

isFlag() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanRequestBody

Return the boolean result.

isFlag() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse

Return the boolean result.

L

logRESTCall(String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTCallLogger

Log the start of an inbound REST Call.

logRESTCallReturn(RESTCallToken, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTCallLogger

Log the return of an inbound REST Call.

N

NameListResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

NameListResponse is the response structure used on the OMAS REST API calls that return a list of names as a response.

NameListResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse

Default constructor

NameListResponse(NameListResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse

Copy/clone constructor

NullRequestBody - Class in org.odpi.openmetadata.commonservices.ffdc.rest

NullRequestBody provides a empty request body object for POST requests that do not need to send additional parameters beyond the path variables.

NullRequestBody() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody

Default constructor

NullRequestBody(NullRequestBody) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody

Copy/clone constructor

O

OMAGCheckedExceptionBase - Exception in org.odpi.openmetadata.commonservices.ffdc.exceptions

OMAGCheckedExceptionBase provides a checked exception for reporting errors found when using the Open Metadata and Governance (OMAG) services.

OMAGCheckedExceptionBase(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

This is the typical constructor used for creating an exception.

OMAGCheckedExceptionBase(int, String, String, String, String, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

This is the typical constructor used for creating an exception.

OMAGCheckedExceptionBase(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

This is the constructor used for creating an exception that resulted from a previous error.

OMAGCheckedExceptionBase(int, String, String, String, String, String, Throwable, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

This is the constructor used for creating an exception that resulted from a previous error.

OMAGCheckedExceptionBase(String, OMAGCheckedExceptionBase) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

This is the copy/clone constructor used for creating an exception.

OMAGCommonAuditCode - Enum in org.odpi.openmetadata.commonservices.ffdc.auditlog

The OMAGCommonAuditCode is used to define the message content for the OMRS Audit Log.

OMAGCommonErrorCode - Enum in org.odpi.openmetadata.commonservices.ffdc

The OMAGCommonErrorCode is used to define first failure data capture (FFDC) for common errors.

OMAGRuntimeException - Exception in org.odpi.openmetadata.commonservices.ffdc.exceptions

OMAGRuntimeException is used for all runtime exceptions generated by one of the Open Metadata and Governance (OMAG) Services.

OMAGRuntimeException(int, String, String, String, String, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGRuntimeException

This is the typical constructor used for creating an exception.

OMAGRuntimeException(int, String, String, String, String, String, Throwable, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGRuntimeException

This is the constructor used for creating an exception when an unexpected error has been caught.

org.odpi.openmetadata.commonservices.ffdc - package org.odpi.openmetadata.commonservices.ffdc

The FFDC Services provide common exceptions and error handling for service running in OMAG Servers.

org.odpi.openmetadata.commonservices.ffdc.auditlog - package org.odpi.openmetadata.commonservices.ffdc.auditlog

org.odpi.openmetadata.commonservices.ffdc.exceptions - package org.odpi.openmetadata.commonservices.ffdc.exceptions

org.odpi.openmetadata.commonservices.ffdc.rest - package org.odpi.openmetadata.commonservices.ffdc.rest

P

PropertyServerException - Exception in org.odpi.openmetadata.commonservices.ffdc.exceptions

The PropertyServerException is thrown by the OMAG Service when it is not able to communicate with the property server.

PropertyServerException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

This is the typical constructor used for creating an exception.

PropertyServerException(int, String, String, String, String, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

This is the typical constructor used for creating an exception.

PropertyServerException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

This is the constructor used for creating an exception that resulted from a previous error.

PropertyServerException(int, String, String, String, String, String, Throwable, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

This is the constructor used for creating an exception that resulted from a previous error.

PropertyServerException(PropertyServerException) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

This is the copy/clone constructor used for creating an exception.

R

RegisteredOMAGService - Class in org.odpi.openmetadata.commonservices.ffdc.rest

RegisteredOMAGServicesResponse provides an object for returning information about a service that is registered with an OMAG Server Platform.

RegisteredOMAGService() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Default constructor

RegisteredOMAGService(RegisteredOMAGService) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Copy/clone constructor

RegisteredOMAGServicesResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

RegisteredOMAGServicesResponse provides a response object for returning information about a list of services that are registered in an OMAG Server Platform.

RegisteredOMAGServicesResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse

Default constructor

RegisteredOMAGServicesResponse(RegisteredOMAGServicesResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse

Copy clone constructor

RESTCallLogger - Class in org.odpi.openmetadata.commonservices.ffdc

RESTCallLogger provides standard logging for REST API method invocations.

RESTCallLogger(Logger, String) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.RESTCallLogger

Create a REST Call logger for a REST Service.

RESTCallToken - Class in org.odpi.openmetadata.commonservices.ffdc

RESTCallToken provides a cache of information about a single REST API call invocation.

RESTExceptionHandler - Class in org.odpi.openmetadata.commonservices.ffdc

RESTExceptionHandler converts standard exceptions to REST responses.

RESTExceptionHandler() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Constructor

S

serverName - Variable in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

serverPlatformURLRoot - Variable in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

setCount(long) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.CountResponse

Set up count of objects.

setExceptionClassName(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Set up the name of the Java class name to use to recreate the exception.

setExceptionErrorMessage(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Set up the error message associated with the exception.

setExceptionProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Set up the additional properties stored by the exceptions.

setExceptionSystemAction(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Set up the description of the action taken by the system as a result of the exception.

setExceptionUserAction(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Set up the action that a user should take to resolve the problem.

setFlag(boolean) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanRequestBody

Set up the boolean result.

setFlag(boolean) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse

Set up the boolean result.

setGUID(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse

Set up the guid result.

setGUIDs(List<String>) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse

Set up the guids result.

setMaxPagingSize(int) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Override the default maximum paging size.

setNames(List<String>) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse

Set up the name list result.

setRelatedHTTPCode(int) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

Set up the HTTP Code to use if forwarding response to HTTP client.

setResultString(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse

Set up the resultString result.

setServiceDescription(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Set up the default description for this service.

setServiceName(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Set up the default name for this service

setServices(List<RegisteredOMAGService>) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse

Set up the list of services

setServiceURLMarker(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Set up the string that appears in the REST API URL that identifies the owning service.

setServiceWiki(String) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

Set up the URL for the wiki page describing this service.

setStringMap(Map<String, String>) - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

Set up the name to description map result.

StringMapResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

StringMapResponse is the response structure used on the OMAS REST API calls that return a map of names to description as a response.

StringMapResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

Default constructor

StringMapResponse(StringMapResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

Copy/clone constructor

StringResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.

StringResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse

Default constructor

StringResponse(StringResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse

Copy/clone constructor

T

throwCannotDeleteElementInUse(String, String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception to indicate that the call to a method is not supported.

throwMethodNotSupported(String, String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception to indicate that the call to a method is not supported.

throwUnexpectedException(String, FFDCResponseBase) - Method in class org.odpi.openmetadata.commonservices.ffdc.RESTExceptionHandler

Manage an unexpected exception

throwUnknownElement(String, String, String, String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception to indicate that the requested element is not recognized.

toString() - Method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

JSON-style toString

toString() - Method in exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

JSON-style toString

toString() - Method in exception org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGRuntimeException

JSON-style toString

toString() - Method in exception org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

JSON-style toString

toString() - Method in exception org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException

JSON-style toString

toString() - Method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanRequestBody

Standard toString method.

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse

Standard toString method.

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.CountResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

JSON-like toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody

JSON-like toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse

JSON-style toString

U

UserNotAuthorizedException - Exception in org.odpi.openmetadata.commonservices.ffdc.exceptions

The UserNotAuthorizedException is thrown by the OMAG Service when a userId passed on a request is not authorized to perform the requested action.

UserNotAuthorizedException(int, String, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException

This is the typical constructor used for creating an exception.

UserNotAuthorizedException(int, String, String, String, String, String, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException

This is the typical constructor used for creating an exception.

UserNotAuthorizedException(int, String, String, String, String, String, Throwable, String) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException

This is the constructor used for creating an exception that resulted from a previous error.

UserNotAuthorizedException(int, String, String, String, String, String, Throwable, String, Map<String, Object>) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException

This is the constructor used for creating an exception that resulted from a previous error.

UserNotAuthorizedException(UserNotAuthorizedException) - Constructor for exception org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException

This is the copy/clone constructor used for creating an exception.

V

validateAssetInSupportedZone(String, String, List<String>, List<String>, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Compare the supported zones with the zones stored in the asset.

validateConnection(Connection, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied connection is null

validateEnum(Object, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied enum is null

validateGUID(String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied userId is null

validateName(String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied userId is null

validateObject(Object, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied userId is null

validateOMAGServerPlatformURL(String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if a server URL or has not been supplied.

validateOMAGServerPlatformURL(String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if a server URL or has not been supplied.

validatePaging(int, int, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied paging values don't make sense.

validateSearchString(String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied userId is null

validateStringArray(List<String>, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied array is null or empty

validateText(String, String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied text field is null

validateTypeName(String, String, String, String, OMRSRepositoryHelper) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied type name is not recognized not of the correct subclass

validateUserId(String, String) - Method in class org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler

Throw an exception if the supplied userId is null

valueOf(String) - Static method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

VoidResponse - Class in org.odpi.openmetadata.commonservices.ffdc.rest

VoidResponse defines the response structure for the OMAS REST API calls that returns a void as a response.

VoidResponse() - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse

Default constructor

VoidResponse(VoidResponse) - Constructor for class org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse

Copy/clone constructor

B C D E F G H I L N O P R S T U V