A C E G H M O P R S T V

A

addStoredServer(StoredServer) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Add a stored server to the platform

C

captureCheckedException(FFDCResponse, OCFCheckedExceptionBase, String) - Static method in class org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorExceptionHandler

Method for capturing an exception into a REST response.

E

equals(Object) - Method in exception org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewServiceException

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

equals(Object) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

equals(Object) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

G

getDescription() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.properties.PlatformStatus

Return the description for the enum.

getMessageDefinition() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewAuditCode

Retrieve a message definition object for logging.

getMessageDefinition(String...) - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewAuditCode

Retrieve a message definition object for logging.

getMessageDefinition() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewErrorCode

Retrieve a message definition object for an exception.

getMessageDefinition(String...) - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewErrorCode

Retrieve a message definition object for an exception.

getName() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.properties.PlatformStatus

Return the descriptive name for the enum.

getOmagServerConfig() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse

Get the Open Metadata and governance (OMAG) Server configuration

getOrdinal() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.properties.PlatformStatus

Return the numerical value for the enum.

getPlatformDescription() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Get the platform description

getPlatformList() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorResourceEndpointListResponse

Return the platformList.

getPlatformName() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Get the platform name

getPlatformName() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Get the platform name

getPlatforms() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorPlatformsResponse

Get the platforms

getPlatformStatus() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

return the status of the platform

getResourceCategory() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

get the resource category

getResourceDescription() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Get the resource description

getResourceRootURL() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

get the resource root URL

getServerInstanceName() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Get server instance name

getServerName() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

get the server anme

getServerType() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Get the type of the stored Server

getStoredServerDescription() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Get the storedServer description

getStoredServerName() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Get the storedServer name

getStoredServers() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Set the stored servers on this platform

H

hashCode() - Method in exception org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewServiceException

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

hashCode() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

hashCode() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

M

mapOMAGConfigurationErrorException(String, String, OMAGConfigurationErrorException) - Static method in class org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorExceptionHandler

Map an OMAG configuration exception to a ServerAuthorViewServiceException

mapOMAGInvalidParameterException(String, String, OMAGInvalidParameterException) - Static method in class org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorExceptionHandler

Map an OMAGInvalidParameterException to a ServerAuthorViewServiceException which is more consumable / meaningful to the UI

mapOMAGUserNotAuthorizedException(String, String, OMAGNotAuthorizedException) - Static method in class org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorExceptionHandler

Map an OMAGNotAuthorizedException to a ServerAuthorViewServiceException which is more consumable / meaningful to the UI

O

org.odpi.openmetadata.viewservices.serverauthor.api.ffdc - package org.odpi.openmetadata.viewservices.serverauthor.api.ffdc

This package provides the definition of the Java API for the Server Author OMVS.

org.odpi.openmetadata.viewservices.serverauthor.api.properties - package org.odpi.openmetadata.viewservices.serverauthor.api.properties

This package provides the definition of the Java API for the Server Author OMVS.

org.odpi.openmetadata.viewservices.serverauthor.api.rest - package org.odpi.openmetadata.viewservices.serverauthor.api.rest

This package defines the beans used to build the REST request and response payloads.

P

Platform - Class in org.odpi.openmetadata.viewservices.serverauthor.api.properties

Platform() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Default Constructor sets the properties to nulls

Platform(String, String) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Constructor

PlatformStatus - Enum in org.odpi.openmetadata.viewservices.serverauthor.api.properties

The status of the platform for the Server Author View.

R

ResourceEndpoint - Class in org.odpi.openmetadata.viewservices.serverauthor.api.properties

ResourceEndpoint() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Default Constructor sets the properties to nulls

ResourceEndpoint(String, String, String, String, String, String) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Constructor

ResourceEndpoint(ResourceEndpointConfig) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Config constructor - create a ResourceEndpoint from a ResourceEndpointConfig

S

ServerAuthorConfigurationResponse - Class in org.odpi.openmetadata.viewservices.serverauthor.api.rest

A server Author response containing an Open Metadata and governance (OMAG) Server configuration

ServerAuthorConfigurationResponse() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse

Default constructor

ServerAuthorConfigurationResponse(ServerAuthorConfigurationResponse) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse

Copy/clone constructor

ServerAuthorExceptionHandler - Class in org.odpi.openmetadata.viewservices.serverauthor.api.ffdc

The Server Author Exception handler maps OMAG exceptions that have been produced by the admin client into Server author Exceptions.

ServerAuthorExceptionHandler() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorExceptionHandler

ServerAuthorPlatformsResponse - Class in org.odpi.openmetadata.viewservices.serverauthor.api.rest

A Server Author response containing the known platforms

ServerAuthorPlatformsResponse() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorPlatformsResponse

Default constructor

ServerAuthorPlatformsResponse(ServerAuthorPlatformsResponse) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorPlatformsResponse

Copy/clone constructor

ServerAuthorResourceEndpointListResponse - Class in org.odpi.openmetadata.viewservices.serverauthor.api.rest

Server Author's list of Resource endpoints, which contains the list of platforms.

ServerAuthorResourceEndpointListResponse() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorResourceEndpointListResponse

Default constructor

ServerAuthorResourceEndpointListResponse(ServerAuthorResourceEndpointListResponse) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorResourceEndpointListResponse

Copy/clone constructor

ServerAuthorViewAuditCode - Enum in org.odpi.openmetadata.viewservices.serverauthor.api.ffdc

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

ServerAuthorViewErrorCode - Enum in org.odpi.openmetadata.viewservices.serverauthor.api.ffdc

The ServerAuthorViewErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMVS It is used in conjunction with all OMVS Exceptions.

ServerAuthorViewOMVSAPIResponse - Class in org.odpi.openmetadata.viewservices.serverauthor.api.rest

ServerAuthorViewOMVSAPIResponse provides a common header for the Server Author OMVS managed rest to its REST API.

ServerAuthorViewOMVSAPIResponse() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorViewOMVSAPIResponse

Default constructor

ServerAuthorViewOMVSAPIResponse(ServerAuthorViewOMVSAPIResponse) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorViewOMVSAPIResponse

Copy/clone constructor

ServerAuthorViewServiceException - Exception in org.odpi.openmetadata.viewservices.serverauthor.api.ffdc

This is a simple exception class that can convey the few types of exception that it is sensible to propagate back to the user interface.

ServerAuthorViewServiceException(ExceptionMessageDefinition, String, String) - Constructor for exception org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewServiceException

Constructor

setOmagServerConfig(OMAGServerConfig) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse

set the Open Metadata and governance (OMAG) Server configuration

setPlatformDescription(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Set the description for the platform

setPlatformList(List<ResourceEndpoint>) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorResourceEndpointListResponse

Set the resourceEndpointList.

setPlatformName(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Set a meaningful name for the platform

setPlatformName(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Set a meaningful name for the platform

setPlatforms(Set<Platform>) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorPlatformsResponse

set the platforms

setPlatformStatus(PlatformStatus) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Set the platform status

setResourceCategory(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Set the resource category

setResourceDescription(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Set the resource description

setResourceRootURL(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

set the resource root URL

setServerInstanceName(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

set server instance name

setServerName(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

Set the server name

setServerType(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Set the type for the storedServer

setStoredServerDescription(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Set the description for the storedServer

setStoredServerName(String) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Set a meaningful name for the storedServer

setStoredServers(Set<StoredServer>) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

Get the stored servers on this platform

StoredServer - Class in org.odpi.openmetadata.viewservices.serverauthor.api.properties

StoredServer() - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Default Constructor sets the properties to nulls

StoredServer(String, String, String) - Constructor for class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

Constructor

T

toString() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewAuditCode

JSON-style toString

toString() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewErrorCode

toString() JSON-style

toString() - Method in exception org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewServiceException

JSON-style toString

toString() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

toString(StringBuilder) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.Platform

toString() - Method in enum org.odpi.openmetadata.viewservices.serverauthor.api.properties.PlatformStatus

toString() JSON-style

toString() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

toString(StringBuilder) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.ResourceEndpoint

toString() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

toString(StringBuilder) - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.properties.StoredServer

toString() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorConfigurationResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorPlatformsResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorResourceEndpointListResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.viewservices.serverauthor.api.rest.ServerAuthorViewOMVSAPIResponse

JSON-like toString

V

valueOf(String) - Static method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewAuditCode

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

valueOf(String) - Static method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewErrorCode

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

valueOf(String) - Static method in enum org.odpi.openmetadata.viewservices.serverauthor.api.properties.PlatformStatus

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

values() - Static method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewAuditCode

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

values() - Static method in enum org.odpi.openmetadata.viewservices.serverauthor.api.ffdc.ServerAuthorViewErrorCode

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

values() - Static method in enum org.odpi.openmetadata.viewservices.serverauthor.api.properties.PlatformStatus

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

A C E G H M O P R S T V