- getAuditLogConnections() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Return the Connection properties used to create an OCF Connector to the AuditLog.
- getAuditTrail() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Return the list of audit log entries associated with this config file.
- getAuthenticationSource() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Return the authentication source.
- getConnection() - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse
-
Return the Connection object.
- getDescription() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Server description
- 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.
- getGovernanceServersDescriptionList() - Static method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription
-
Return a list containing each of the view service descriptions defined in this enum class.
- getHTTPErrorCode() - Method in enum org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode
-
- getLocalServerId() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Return the service name (the UI calls the services views).
- 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.
- 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.
- getServiceCode() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription
-
Return the code for this enum instance
- getServiceDescription() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription
-
Return the default description for the type for this enum instance.
- getServiceName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
- getServiceName() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription
-
Return the default name for this enum instance.
- getServiceURLMarker() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription
-
Return the string that appears in the REST API URL that identifies the owning service.
- getServiceWiki() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription
-
Return the URL for the wiki page describing this view service.
- 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.
- getTypeCode() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceOperationalStatus
-
Return the code for this enum instance
- getTypeDescription() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceOperationalStatus
-
Return the default description for the type for this enum instance.
- getTypeName() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceOperationalStatus
-
Return the default name for this enum instance.
- 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.
- getViewServiceAdminClass() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the Java class name of the admin-services interface for this view service.
- getViewServiceAdminClassName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Return the class name of the admin class that should be called during initialization and
termination.
- getViewServiceCode() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceDescription
-
Return the code for this enum instance
- getViewServiceCode() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Return the code for this view service
- getViewServiceConfigs() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Return the configuration for the registered view services.
- getViewServiceDescription() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the short description of the view service.
- getViewServiceDescription() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceDescription
-
Return the default description for the type for this enum instance.
- getViewServiceDescription() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Return the default description for the type for this view service.
- getViewServiceId() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the code number (ordinal) for this view service.
- getViewServiceName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the name of the view service.
- getViewServiceName() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceDescription
-
Return the default name for this enum instance.
- getViewServiceName() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Return the default name for this view service.
- getViewServiceOperationalStatus() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the status of this view service.
- getViewServiceOperationalStatus() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Return the initial operational status for this view service.
- getViewServiceOptions() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the options for this view service.
- getViewServiceURLMarker() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the string that appears in the REST API URL that identifies the owning service.
- getViewServiceURLMarker() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceDescription
-
Return the string that appears in the REST API URL that identifies the owning service.
- getViewServiceURLMarker() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Return the string that appears in the REST API URL that identifies the owning service.
- getViewServiceWiki() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Return the wiki page link for the view service.
- getViewServiceWiki() - Method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceDescription
-
Return the URL for the wiki page describing this UI view.
- getViewServiceWiki() - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Return the URL for the wiki page describing this view service.
- saveServerConfig(UIServerConfig) - Method in interface org.odpi.openmetadata.userinterface.adminservices.store.UIServerConfigStore
-
Save the server configuration.
- setAuditLogConnections(List<Connection>) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Set up the Connection properties used to create an OCF Connector to the AuditLog.
- setAuditTrail(List<String>) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Set up the audit log messages.
- setAuthenticationSource(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Set up the authentication source.
- setConnection(Connection) - Method in class org.odpi.openmetadata.userinterface.adminservices.rest.ConnectionResponse
-
Set up the Connection object.
- setDescription(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Set up server description
- 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.
- 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.
- setServiceName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Set up the service name (the UI calls the services views).
- setServiceURLMarker(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the string that appears in the REST API URL that identifies the owning service.
- setServiceURLMarker(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Set up the string that appears in the REST API URL that identifies the owning service.
- 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.
- setViewServiceAdminClass(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the Java class name of the admin services interface for this view service.
- setViewServiceAdminClassName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Set up the class name of the admin class that should be called during initialization and
termination.
- setViewServiceCode(int) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Set up the code for this view service
- setViewServiceConfigs(List<ViewServiceConfig>) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig
-
Set up the configuration for the registered view services.
- setViewServiceDescription(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the short description of the view service.
- setViewServiceDescription(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Set up the default description for the type for this view service.
- setViewServiceId(int) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the code number (ordinal) for this view service.
- setViewServiceName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the name of the view service.
- setViewServiceName(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Set up the default name for this view service.
- setViewServiceOperationalStatus(ViewServiceOperationalStatus) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the status of the view service.
- setViewServiceOperationalStatus(ViewServiceOperationalStatus) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Set up the initial operational status for this view service.
- setViewServiceOptions(Map<String, Object>) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the options for this view service.
- setViewServiceWiki(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the wiki page link for the view service.
- setViewServiceWiki(String) - Method in class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Set up the URL for the wiki page describing this view service.
- 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
- valueOf(String) - Static method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.CommonUIServicesDescription
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceDescription
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceOperationalStatus
-
Returns the enum constant of this type with the specified name.
- 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.configuration.registration.CommonUIServicesDescription
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceDescription
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceOperationalStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- 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
-
- ViewServiceConfig - Class in org.odpi.openmetadata.userinterface.adminservices.configuration.properties
-
ViewServiceConfig provides the configuration for a single Open Metadata View Service (OMVS).
- ViewServiceConfig() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Default constructor for use with Jackson libraries
- ViewServiceConfig(ViewServiceConfig) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Copy/clone constructor
- ViewServiceConfig(ViewServiceRegistration) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.properties.ViewServiceConfig
-
Set up the default values for an view service using an view service description.
- ViewServiceDescription - Enum in org.odpi.openmetadata.userinterface.adminservices.configuration.registration
-
ViewServiceDescription provides a list of registered view services.
- ViewServiceOperationalStatus - Enum in org.odpi.openmetadata.userinterface.adminservices.configuration.registration
-
ViewServiceOperationalStatus sets up whether an open metadata view service (OMVS) is enabled or not.
- ViewServiceRegistration - Class in org.odpi.openmetadata.userinterface.adminservices.configuration.registration
-
ViewServiceRegistration is used by a ui view to register its admin services interface
- ViewServiceRegistration(int, String, String, String, String, ViewServiceOperationalStatus, String) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Complete Constructor
- ViewServiceRegistration(ViewServiceDescription, ViewServiceOperationalStatus, String) - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Enum Constructor
- ViewServiceRegistration() - Constructor for class org.odpi.openmetadata.userinterface.adminservices.configuration.registration.ViewServiceRegistration
-
Default constructor