Index (User Interface Administration Services API 1.1 API)

C E G H I O R S T U V

C

ConnectionResponse - Class in org.odpi.openmetadata.userinterface.adminservices.rest: ConnectionResponse is the response structure used on the REST API calls that return a Connection object as a response.
ConnectionResponse() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse: Default constructor
ConnectionResponse(ConnectionResponse) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse: Copy/clone constructor

E

equals(Object) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint
equals(Object) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Validate that an object is equal depending on their stored values.
equals(Object) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse: Return comparison result based on the content of the properties.
equals(Object) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.UIServerConfigResponse: Compare the values of the supplied object with those stored in the current object.
equals(Object) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.URLRequestBody: Compare objects

G

getAuditTrail() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the list of audit log entries associated with this config file.
getConnection() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse: Return the Connection object.
getErrorMessageId() - Method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode: Returns the unique identifier for the error message.
getFormattedErrorMessage(String...) - Method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode: Returns the error message with the placeholders filled out with the supplied parameters.
getGovernanceServerEndpoints() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set the governance endpoints, which if specified for an governance override the metadata endpoint return GovernanceServerEndpoint the governance endpoints
getGovernanceServiceName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint: Governance service name.
getHTTPErrorCode() - Method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode
getLocalServerId() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return an unique identifier for this server.
getLocalServerName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the name of the ui server.
getLocalServerPassword() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the password that the ui server should use on outbound REST calls (this is the password for the localServerUserId).
getLocalServerType() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the descriptive name for the server type.
getLocalServerURL() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the base URL for calling the ui server.
getLocalServerUserId() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the userId that the ui server should use when processing events and there is no external user driving the operation.
getMaxPageSize() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the maximum page size supported by this server.
getMetadataServerName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: get the metadata server
getMetadataServerURL() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: The metadata server url
getOrganizationName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the name of the organization that is running the server.
getServerName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint: the serverName for the governance server.
getServerRootURL() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint: The serverRootURL for the governance server.
getServerSecurityConnection() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the connection for the optional server security connector that validates calls to this server from admin to operations to metadata and governance services.
getSuccessMessage() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.SuccessMessageResponse: Return the success message (if any).
getSystemAction() - Method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode: Returns a description of the action taken by the system when the condition that caused this exception was detected.
getUIServerConfig() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.UIServerConfigResponse: Return the UIServerConfig object.
getUnformattedErrorMessage() - Method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode: Returns the error message with placeholders for specific details.
getUrlRoot() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.URLRequestBody: Return the URL root (typically host name and port).
getUserAction() - Method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode: Returns instructions of how to resolve the issue reported in this exception.
getVersionId() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return the versionId of this document.
GovernanceServerEndpoint - Class in org.odpi.openmetadata.userinterface.adminservices.configuration.properties: org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint an endpoint for each governance server.
GovernanceServerEndpoint() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint

H

hashCode() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint
hashCode() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Return a hash code based on the values of this object.
hashCode() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse: Return hash code for this object
hashCode() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.UIServerConfigResponse: Create a hash code for this element type.
hashCode() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.URLRequestBody: Simple hash for the object

I

isGovernanceServerNameValid(String) - Static method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.validators.UIConfigValidators
isURLValid(String) - Static method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.validators.UIConfigValidators

O

org.odpi.openmetadata.userinterface.adminservices.configuration.properties - package org.odpi.openmetadata.userinterface.adminservices.configuration.properties
org.odpi.openmetadata.userinterface.adminservices.configuration.properties.validators - package org.odpi.openmetadata.userinterface.adminservices.configuration.properties.validators
org.odpi.openmetadata.userinterface.adminservices.ffdc - package org.odpi.openmetadata.userinterface.adminservices.ffdc
org.odpi.openmetadata.userinterface.adminservices.ffdc.exception - package org.odpi.openmetadata.userinterface.adminservices.ffdc.exception
org.odpi.openmetadata.userinterface.adminservices.rest - package org.odpi.openmetadata.userinterface.adminservices.rest
org.odpi.openmetadata.userinterface.adminservices.store - package org.odpi.openmetadata.userinterface.adminservices.store

R

removeServerConfig() - Method in interface org.odpi.openmetadata.userinterface.adminservices.store.UIServerConfigStore: Remove the server configuration.
retrieveServerConfig() - Method in interface org.odpi.openmetadata.userinterface.adminservices.store.UIServerConfigStore: Retrieve the configuration saved from a previous run of the server.

S

saveServerConfig(UIServerConfig) - Method in interface org.odpi.openmetadata.userinterface.adminservices.store.UIServerConfigStore: Save the server configuration.
setAuditTrail(List<String>) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the audit log messages.
setConnection(Connection) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse: Set up the Connection object.
setGovernanceServerEndpoints(List<GovernanceServerEndpoint>) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set the governance endpoints, which if specified for an governance service override the Metadata endpoint
setGovernanceServiceName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint: Set up the governance service Name for the governance server.
setLocalServerId(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up a unique identifier for this server.
setLocalServerName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the name of the ui server.
setLocalServerPassword(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the password that the ui server should use on outbound REST calls (this is the password for the localServerUserId).
setLocalServerType(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the descriptive name for the server type.
setLocalServerURL(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the base URL for calling the ui server.
setLocalServerUserId(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the userId that the ui server should use when processing events and there is no external user driving the operation.
setMaxPageSize(int) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the maximum page size supported by this server.
setMetadataServerName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the localServerName for the metadata server.
setMetadataServerURL(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the connection for the optional server security connector that validates calls to this server from admin to operations to metadata and governance services.
setOrganizationName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the name of the organization that is running the server.
setServerName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint: Set up the serverName for the governance server.
setServerRootURL(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint: Set up the serverRootURL for the governance server.
setServerSecurityConnection(Connection) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the connection for the optional server security connector that validates calls to this server from admin to operations to metadata and governance services.
setSuccessMessage(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.SuccessMessageResponse: Set up the success message.
setUIServerConfig(UIServerConfig) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.UIServerConfigResponse: Set up the UIServerConfig object.
setUrlRoot(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.URLRequestBody: Set up the URL root (typically host name and port).
setVersionId(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Set up the versionId of this document.
SuccessMessageResponse - Class in org.odpi.openmetadata.userinterface.adminservices.rest
SuccessMessageResponse() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.SuccessMessageResponse: Default constructor
SuccessMessageResponse(SuccessMessageResponse) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.SuccessMessageResponse: Copy/clone constructor

T

toString() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint
toString() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Standard toString method.
toString() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse: JSON-style toString
toString() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.SuccessMessageResponse: JSON-like toString
toString() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.UIAdminServicesAPIResponse: JSON-like toString
toString() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.UIServerConfigResponse: Standard toString method.
toString() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.URLRequestBody: JSON-style toString

U

UIAdminErrorCode - Enum in org.odpi.openmetadata.userinterface.adminservices.ffdc: The UIAdminErrorCode is used to define first failure data capture (FFDC) for errors that occur within the UI Server It is used in conjunction with UI Exceptions, both Checked and Runtime (unchecked).
UIAdminServicesAPIResponse - Class in org.odpi.openmetadata.userinterface.adminservices.rest: UIAdminServicesAPIResponse provides a common header for admin services managed response to its REST API.
UIAdminServicesAPIResponse() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.UIAdminServicesAPIResponse: Default constructor
UIAdminServicesAPIResponse(UIAdminServicesAPIResponse) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.UIAdminServicesAPIResponse: Copy/clone constructor
UIAdminServicesConfigHeader - Class in org.odpi.openmetadata.userinterface.adminservices.configuration.properties: org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIAdminServicesConfigHeader provides a common header for configuration properties.
UIAdminServicesConfigHeader() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIAdminServicesConfigHeader: Default Constructor
UIAdminServicesConfigHeader(UIAdminServicesConfigHeader) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIAdminServicesConfigHeader: Copy/clone constructor
UICheckedExceptionBase - Exception in org.odpi.openmetadata.userinterface.adminservices.ffdc.exception: UICheckedExceptionBase provides a checked exception for reporting errors found when using the OMAG Server.
UICheckedExceptionBase(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UICheckedExceptionBase: This is the typical constructor used for creating a OMRSCheckedExceptionBase.
UICheckedExceptionBase(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UICheckedExceptionBase: This is the constructor used for creating a OMRSCheckedExceptionBase when an unexpected error has been caught.
UIConfigurationErrorException - Exception in org.odpi.openmetadata.userinterface.adminservices.ffdc.exception: UIConfigurationErrorException is used when configuration parameters passed on earlier calls turn out to be invalid or make the new call invalid.
UIConfigurationErrorException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UIConfigurationErrorException: This is the typical constructor used for creating a UIConfigurationErrorException.
UIConfigurationErrorException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UIConfigurationErrorException: This is the constructor used for creating a UIConfigurationErrorException that resulted from a previous error.
UIConfigurationErrorException(PropertyServerException) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UIConfigurationErrorException: This is the constructor used for creating a UIConfigurationErrorException that resulted from a previous error.
UIConfigValidators - Class in org.odpi.openmetadata.userinterface.adminservices.configuration.properties.validators: org.odpi.openmetadata.userinterface.adminservices.configuration.properties.GovernanceServerEndpoint an endpoint for each governance server.
UIConfigValidators() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.validators.UIConfigValidators
UIInvalidParameterException - Exception in org.odpi.openmetadata.userinterface.adminservices.ffdc.exception: UIInvalidParameterException is used when invalid parameters are passed on an OMAG call.
UIInvalidParameterException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UIInvalidParameterException: This is the typical constructor used for creating a UIInvalidParameterException.
UIInvalidParameterException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UIInvalidParameterException: This is the constructor used for creating a UIInvalidParameterException that resulted from a previous error.
UIInvalidParameterException(InvalidParameterException) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UIInvalidParameterException: This is the constructor used for creating a UIInvalidParameterException that resulted from a previous error.
UINotAuthorizedException - Exception in org.odpi.openmetadata.userinterface.adminservices.ffdc.exception: UINotAuthorizedException is used when invalid parameters are passed on an OMAG call.
UINotAuthorizedException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UINotAuthorizedException: This is the typical constructor used for creating a UINotAuthorizedException.
UINotAuthorizedException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UINotAuthorizedException: This is the constructor used for creating a UINotAuthorizedException that resulted from a previous error.
UINotAuthorizedException(UserNotAuthorizedException) - Constructor for exception org.odpi.openmetadata.userinterface.adminservices.ffdc.exception.UINotAuthorizedException: This is the constructor used for creating a UINotAuthorizedException that resulted from a previous error.
UIServerConfig - Class in org.odpi.openmetadata.userinterface.adminservices.configuration.properties: org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig provides the properties used to initialize a user interface open metadata and governance (OMAG) server.
UIServerConfig() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Default constructor.
UIServerConfig(UIServerConfig) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig: Copy/clone constructor.
UIServerConfigResponse - Class in org.odpi.openmetadata.userinterface.adminservices.rest: UIServerConfigResponse is the response structure used on the OMAG REST API calls that returns a Connection object as a response.
UIServerConfigResponse() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.UIServerConfigResponse: Default constructor
UIServerConfigStore - Interface in org.odpi.openmetadata.userinterface.adminservices.store: UIServerConfigStore provides the interface to the configuration for a UI Server.
UIServerConfigStoreConnectorBase - Class in org.odpi.openmetadata.userinterface.adminservices.store: UIServerConfigStoreConnectorBase provides the base class for a UI Server's configuration store.
UIServerConfigStoreConnectorBase() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.store.UIServerConfigStoreConnectorBase
UIServerConfigStoreProviderBase - Class in org.odpi.openmetadata.userinterface.adminservices.store: The UIServerConfigStoreProviderBase provides a base class for the connector provider supporting the UI server configuration stores.
UIServerConfigStoreProviderBase() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.store.UIServerConfigStoreProviderBase: Default Constructor
URLRequestBody - Class in org.odpi.openmetadata.userinterface.adminservices.rest
URLRequestBody() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.URLRequestBody: Default constructor
URLRequestBody(URLRequestBody) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.rest.URLRequestBody: Copy/clone constructor

V

valueOf(String) - Static method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_ONE - Static variable in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig

C E G H I O R S T U V