Index (Administration Services API 0.1 API)

A C E G I L O R S T V

A

AccessServiceAdmin - Interface in org.odpi.openmetadata.adminservices.configuration.registration: AccessServiceAdmin is the interface that an access service implements to receive its configuration.
AccessServiceConfig - Class in org.odpi.openmetadata.adminservices.configuration.properties: AccessServiceConfig provides the configuration for a single Open Metadata Access Service (OMAS).
AccessServiceConfig() - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Default constructor for use with Jackson libraries
AccessServiceConfig(AccessServiceRegistration) - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the default values for an access service using an access service description.
AccessServiceDescription - Enum in org.odpi.openmetadata.adminservices.configuration.registration: AccessServiceDescription provides a list of registered OMAS services.
AccessServiceOperationalStatus - Enum in org.odpi.openmetadata.adminservices.configuration.registration: AccessServiceOperationalStatus sets up whether an open metadata access service (OMAS) is enabled or not.
AccessServiceRegistration - Class in org.odpi.openmetadata.adminservices.configuration.registration: AccessServiceRegistration is used by an access service to register its admin services interface
AccessServiceRegistration(int, String, String, String, AccessServiceOperationalStatus, String) - Constructor for class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Complete Constructor
AccessServiceRegistration() - Constructor for class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Default constructor

C

CohortConfig - Class in org.odpi.openmetadata.adminservices.configuration.properties: CohortConfig provides the configuration properties used to connect to an open metadata repository cohort.
CohortConfig() - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Default constructor does nothing.
CohortConfig(String, Connection, Connection, OpenMetadataExchangeRule, List<TypeDefSummary>) - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Constructor to populate all config values.

E

EnterpriseAccessConfig - Class in org.odpi.openmetadata.adminservices.configuration.properties: EnterpriseAccessConfig describes the properties that control the enterprise access services that the OMRS provides to the Open Metadata Access Services (OMASs).
EnterpriseAccessConfig() - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Default Constructor does nothing.
EnterpriseAccessConfig(String, String, Connection, OpenMetadataEventProtocolVersion) - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Constructor to set up all configuration values.
EventBusConfig - Class in org.odpi.openmetadata.adminservices.configuration.properties: EventBusConfig caches the properties that are used to set up event-based connectors in the server.
EventBusConfig() - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Default constructor
EventBusConfig(EventBusConfig) - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Copy/clone constructor

G

getAccessServiceAdminClass() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the Java class name of the adminservices interface for this access service.
getAccessServiceAdminClassName() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the class name of the adminservices class that should be called during initialization and termination.
getAccessServiceCode() - Method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription: Return the code for this enum instance
getAccessServiceCode() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the code for this access service
getAccessServiceDescription() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the short description of the access service.
getAccessServiceDescription() - Method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription: Return the default description for the type for this enum instance.
getAccessServiceDescription() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the default description for the type for this access service.
getAccessServiceDescriptionList() - Static method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription: Return a list containing each of the access service descriptions defined in this enum class.
getAccessServiceId() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the code number (ordinal) for this access service.
getAccessServiceInTopic() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the OCF Connection for the topic used to pass requests to this access service.
getAccessServiceInTopic() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the InTopic name for the access service.
getAccessServiceName() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the name of the access service.
getAccessServiceName() - Method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription: Return the default name for this enum instance.
getAccessServiceName() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the default name for this access service.
getAccessServiceOperationalStatus() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the status of this access service.
getAccessServiceOperationalStatus() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the initial operational status for this access service.
getAccessServiceOptions() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the options for this access service.
getAccessServiceOutTopic() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the OCF Connection for the topic used by this access service to publish events.
getAccessServiceOutTopic() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the OutTopic name for the access service.
getAccessServiceRegistrationList() - Static method in class org.odpi.openmetadata.adminservices.OMAGAccessServiceRegistration: Retrieve the list of registered OMASs
getAccessServicesConfig() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the configuration for the registered Open Metadata Access Services (OMAS).
getAccessServiceWiki() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Return the wiki page link for the access service.
getAccessServiceWiki() - Method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription: Return the URL for the wiki page describing this access service.
getAccessServiceWiki() - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Return the URL for the wiki page describing this access service.
getAdditionalProperties() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Return the additional properties for the event bus connection.
getAuditLogConnections() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Return the Connection properties used to create an OCF Connector to the AuditLog.
getCohortConfigList() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Return the configuration properties for each open metadata repository cluster that this local server connects to.
getCohortName() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Return the name of the cohort.
getCohortOMRSTopicConnection() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Return the connection to the cohort's OMRS Topic.
getCohortOMRSTopicProtocolVersion() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Return the protocol version to use when exchanging events amongst the cohort members.
getCohortRegistryConnection() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Set up the connection to the cohort registry store.
getConnectorProvider() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Return the class name of the connector provider for the event bus.
getDescription() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataEventProtocolVersion: Return the default description for the star rating for this enum instance.
getDescription() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataExchangeRule: Return the description of this metadata instance replication rule.
getEnterpriseAccessConfig() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Return the configuration for the federation services provided by OMRS to the Open Metadata Access Services (OMASs).
getEnterpriseMetadataCollectionId() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Return the unique identifier for the combined metadata collection covered by the connected open metadata repositories.
getEnterpriseMetadataCollectionName() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Return the name of the combined metadata collection covered by the connected open metadata repositories.
getEnterpriseOMRSTopicConnection() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Return the connection for the Enterprise OMRS Topic connector.
getEnterpriseOMRSTopicProtocolVersion() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Return the protocol version to use on the EnterpriseOMRSTopicConnector.
getErrorMessage() - Method in exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: A formatted short description of the cause of the condition that resulted in this exception.
getErrorMessageId() - Method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode: Returns the unique identifier for the error message.
getEventBusConfig() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the information used to create connections to an event bus.
getEventMapperConnection() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the connection properties for the event mapper for the local repository.
getEventsToProcessRule() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Return the rule indicating whether incoming metadata events from a cohort should be processed.
getEventsToSaveRule() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the enumeration describing which open metadata repository events should be saved to the local repository.
getEventsToSendRule() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the enumeration describing which open metadata repository events should be sent from the local repository.
getFormattedErrorMessage(String...) - Method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode: Returns the error message with the placeholders filled out with the supplied parameters.
getHTTPErrorCode() - Method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode
getLocalRepositoryConfig() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Return the configuration properties for the local repository.
getLocalRepositoryLocalConnection() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the connection properties used to create a locally optimized connector to the local repository for use by this local server's components.
getLocalRepositoryRemoteConnection() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the connection properties used to create a connector to the local repository for use by remote servers.
getLocalServerName() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the name of the local server.
getLocalServerType() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the descriptive name for the server type.
getLocalServerURL() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the base URL for calling the local server.
getLocalServerUserId() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the userId that the local server should use when processing events and there is no external user driving the operation.
getMaxPageSize() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the maximum page size supported by this server.
getMetadataCollectionId() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the unique id of local repository's metadata collection.
getName() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataEventProtocolVersion: Return the default symbol for this enum instance.
getName() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataExchangeRule: Return the name of this metadata instance replication rule.
getOpenMetadataArchiveConnections() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Return the list of Connection object, each of which is used to create the Connector to an Open Metadata Archive.
getOrdinal() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataEventProtocolVersion: Return the code for this enum instance
getOrdinal() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataExchangeRule: Return the code number of this metadata instance replication rule.
getOrganizationName() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the name of the organization that is running the server.
getReportedCaughtException() - Method in exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: An exception that was caught and wrapped by this exception.
getReportedHTTPCode() - Method in exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: Return the HTTP response code to use with this exception.
getReportedSystemAction() - Method in exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: A description of the action that the system took as a result of the error condition.
getReportedUserAction() - Method in exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: A description of the action necessary to correct the error.
getReportingActionDescription() - Method in exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: The type of request that the class was performing when the condition occurred that resulted in this exception.
getReportingClassName() - Method in exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: The class that created this exception.
getRepositoryServicesConfig() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Return the Open Metadata Repository Services (OMRS) config.
getSelectedTypesToProcess() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Return the list of TypeDefs used if the eventsToProcess rule (above) says "SELECTED_TYPES" - otherwise it is set to null.
getSelectedTypesToSave() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the list of TypeDefs in supported of the eventsToSave.SELECTED_TYPES option.
getSelectedTypesToSend() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Return the list of TypeDefs in supported of the eventsToSend.SELECTED_TYPES option.
getSystemAction() - Method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode: Returns a description of the action taken by the system when the condition that caused this exception was detected.
getTopicURLRoot() - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Return the root of the topic URL.
getTypeCode() - Method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceOperationalStatus: Return the code for this enum instance
getTypeCode() - Method in enum org.odpi.openmetadata.adminservices.OMAGServiceMode: Return the code for this enum instance
getTypeDescription() - Method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceOperationalStatus: Return the default description for the type for this enum instance.
getTypeDescription() - Method in enum org.odpi.openmetadata.adminservices.OMAGServiceMode: Return the default description for the type for this enum instance.
getTypeName() - Method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceOperationalStatus: Return the default name for this enum instance.
getTypeName() - Method in enum org.odpi.openmetadata.adminservices.OMAGServiceMode: Return the default name for this enum instance.
getUnformattedErrorMessage() - Method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode: Returns the error message with placeholders for specific details.
getUserAction() - Method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode: Returns instructions of how to resolve the issue reported in this exception.

I

initialize(AccessServiceConfig, OMRSTopicConnector, OMRSRepositoryConnector, OMRSAuditLog, String) - Method in interface org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceAdmin: Initialize the access service.

L

LocalRepositoryConfig - Class in org.odpi.openmetadata.adminservices.configuration.properties: LocalRepositoryConfig provides the properties to control the behavior of the metadata repository associated with this server.
LocalRepositoryConfig(String, Connection, Connection, OpenMetadataExchangeRule, List<TypeDefSummary>, OpenMetadataExchangeRule, List<TypeDefSummary>, Connection) - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Constructor
LocalRepositoryConfig() - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Default constructor used for JSON to Java processes - does not do anything useful because all local variables are initialized to null in their declaration.

O

OMAGAccessServiceRegistration - Class in org.odpi.openmetadata.adminservices: OMAGAccessServiceRegistration provides static methods for an access service to register itself with the OMAG Server.
OMAGAccessServiceRegistration() - Constructor for class org.odpi.openmetadata.adminservices.OMAGAccessServiceRegistration
OMAGCheckedExceptionBase - Exception in org.odpi.openmetadata.adminservices.ffdc.exception: OMAGCheckedExceptionBase provides a checked exception for reporting errors found when using the OMAG Server.
OMAGCheckedExceptionBase(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: This is the typical constructor used for creating a OMRSCheckedExceptionBase.
OMAGCheckedExceptionBase(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGCheckedExceptionBase: This is the constructor used for creating a OMRSCheckedExceptionBase when an unexpected error has been caught.
OMAGConfigurationErrorException - Exception in org.odpi.openmetadata.adminservices.ffdc.exception: OMAGConfigurationErrorException is used when configuration parameters passed on earlier calls turn out to be invalid or make the new call invalid.
OMAGConfigurationErrorException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException: This is the typical constructor used for creating a OMAGConfigurationErrorException.
OMAGConfigurationErrorException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException: This is the constructor used for creating a OMAGConfigurationErrorException that resulted from a previous error.
OMAGErrorCode - Enum in org.odpi.openmetadata.adminservices.ffdc: The OMAGErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMAG Server It is used in conjunction with OMAG Exceptions, both Checked and Runtime (unchecked).
OMAGInvalidParameterException - Exception in org.odpi.openmetadata.adminservices.ffdc.exception: OMAGInvalidParameterException is used when invalid parameters are passed on an OMAG call.
OMAGInvalidParameterException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException: This is the typical constructor used for creating a OMAGInvalidParameterException.
OMAGInvalidParameterException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException: This is the constructor used for creating a OMAGInvalidParameterException that resulted from a previous error.
OMAGNotAuthorizedException - Exception in org.odpi.openmetadata.adminservices.ffdc.exception: OMAGNotAuthorizedException is used when invalid parameters are passed on an OMAG call.
OMAGNotAuthorizedException(int, String, String, String, String, String) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException: This is the typical constructor used for creating a OMAGNotAuthorizedException.
OMAGNotAuthorizedException(int, String, String, String, String, String, Throwable) - Constructor for exception org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException: This is the constructor used for creating a OMAGNotAuthorizedException that resulted from a previous error.
OMAGServerConfig - Class in org.odpi.openmetadata.adminservices.configuration.properties: OMAGServerConfig provides the properties used to initialize an open metadata and governance (OMAG) server.
OMAGServerConfig() - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Default constructor used to set all properties to their default value.
OMAGServerConfig(OMAGServerConfig) - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Copy/clone constructor.
OMAGServerConfigStore - Interface in org.odpi.openmetadata.adminservices.store: OMAGServerConfigStore provides the interface to the configuration for an OMAG Server.
OMAGServerConfigStoreConnectorBase - Class in org.odpi.openmetadata.adminservices.store: OMAGServerConfigStoreConnectorBase provides the base class for an OMAG Server's configuration store.
OMAGServerConfigStoreConnectorBase() - Constructor for class org.odpi.openmetadata.adminservices.store.OMAGServerConfigStoreConnectorBase
OMAGServerConfigStoreProviderBase - Class in org.odpi.openmetadata.adminservices.store: The OMAGServerConfigStoreProviderBase provides a base class for the connector provider supporting the OMAG server configuration stores.
OMAGServerConfigStoreProviderBase() - Constructor for class org.odpi.openmetadata.adminservices.store.OMAGServerConfigStoreProviderBase: Default Constructor
OMAGServiceMode - Enum in org.odpi.openmetadata.adminservices: OMAGServiceMode sets up whether an open metadata and governance service (OMAS) is enabled or not.
OpenMetadataEventProtocolVersion - Enum in org.odpi.openmetadata.adminservices.configuration.properties: OpenMetadataEventProtocolVersion provides the identifier for the version number of the event payload.
OpenMetadataExchangeRule - Enum in org.odpi.openmetadata.adminservices.configuration.properties: OpenMetadataExchangeRule controls the sending/receiving of metadata instances on the metadata highway.
org.odpi.openmetadata.adminservices - package org.odpi.openmetadata.adminservices
org.odpi.openmetadata.adminservices.configuration.properties - package org.odpi.openmetadata.adminservices.configuration.properties
org.odpi.openmetadata.adminservices.configuration.registration - package org.odpi.openmetadata.adminservices.configuration.registration
org.odpi.openmetadata.adminservices.ffdc - package org.odpi.openmetadata.adminservices.ffdc
org.odpi.openmetadata.adminservices.ffdc.exception - package org.odpi.openmetadata.adminservices.ffdc.exception
org.odpi.openmetadata.adminservices.store - package org.odpi.openmetadata.adminservices.store

R

registerAccessService(AccessServiceRegistration) - Static method in class org.odpi.openmetadata.adminservices.OMAGAccessServiceRegistration: Register OMAS
removeServerConfig() - Method in interface org.odpi.openmetadata.adminservices.store.OMAGServerConfigStore: Remove the server configuration.
RepositoryServicesConfig - Class in org.odpi.openmetadata.adminservices.configuration.properties: RepositoryServicesConfig provides the configuration properties that are needed by the OMRS components to manage access to the metadata repositories that are members of the open metadata repository clusters that this server connects to.
RepositoryServicesConfig() - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Default constructor does nothing
RepositoryServicesConfig(List<Connection>, List<Connection>, LocalRepositoryConfig, EnterpriseAccessConfig, List<CohortConfig>) - Constructor for class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Constructor to set all properties.
retrieveServerConfig() - Method in interface org.odpi.openmetadata.adminservices.store.OMAGServerConfigStore: Retrieve the configuration saved from a previous run of the server.

S

saveServerConfig(OMAGServerConfig) - Method in interface org.odpi.openmetadata.adminservices.store.OMAGServerConfigStore: Save the server configuration.
setAccessServiceAdminClass(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the Java class name of the admin services interface for this access service.
setAccessServiceAdminClassName(String) - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Set up the class name of the adminservices class that should be called during initialization and termination.
setAccessServiceCode(int) - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Set up the code for this access service
setAccessServiceDescription(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the short description of the access service.
setAccessServiceDescription(String) - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Set up the default description for the type for this access service.
setAccessServiceId(int) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the code number (ordinal) for this access service.
setAccessServiceInTopic(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the OCF Connection for the topic used to pass requests to this access service.
setAccessServiceName(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the name of the access service.
setAccessServiceName(String) - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Set up the default name for this access service.
setAccessServiceOperationalStatus(AccessServiceOperationalStatus) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the status of the access service.
setAccessServiceOperationalStatus(AccessServiceOperationalStatus) - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Set up the initial operational status for this access service.
setAccessServiceOptions(Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the options for this access service.
setAccessServiceOutTopic(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the OCF Connection of the topic used by this access service to publish events.
setAccessServicesConfig(List<AccessServiceConfig>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the configuration for the registered Open Metadata Access Services (OMAS).
setAccessServiceWiki(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.AccessServiceConfig: Set up the wiki page link for the access service.
setAccessServiceWiki(String) - Method in class org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistration: Set up the URL for the wiki page describing this access service.
setAdditionalProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Set up the additional properties for the event bus connection.
setAuditLogConnections(List<Connection>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Set up the Connection properties used to create an OCF Connector to the AuditLog.
setCohortConfigList(List<CohortConfig>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Set up the configuration properties for each open metadata repository cluster that this local server connects to.
setCohortName(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Set up the name of the cohort.
setCohortOMRSTopicConnection(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Set up the connection to the cohort's OMRS Topic.
setCohortOMRSTopicProtocolVersion(OpenMetadataEventProtocolVersion) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Set up the protocol version to use when exchanging events amongst the cohort members.
setCohortRegistryConnection(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Set up the connection for the cohort registry store.
setConnectorProvider(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Set up the class name of the connector provider for the event bus.
setEnterpriseAccessConfig(EnterpriseAccessConfig) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Set up the configuration for the federation services provided by OMRS to the Open Metadata Access Services (OMASs).
setEnterpriseMetadataCollectionId(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Set up the unique identifier for the combined metadata collection covered by the connected open metadata repositories.
setEnterpriseMetadataCollectionName(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Set up the name of the combined metadata collection covered by the connected open metadata repositories.
setEnterpriseOMRSTopicConnection(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Set up the connection for the Enterprise OMRS Topic connector.
setEnterpriseOMRSTopicProtocolVersion(OpenMetadataEventProtocolVersion) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EnterpriseAccessConfig: Set up the protocol version to use on the EnterpriseOMRSTopicConnector.
setEventBusConfig(EventBusConfig) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the information used to create connections to an event bus.
setEventMapperConnection(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the connection properties for the event mapper for the local repository.
setEventsToProcessRule(OpenMetadataExchangeRule) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Set up the rule indicating whether incoming metadata events from a cohort should be processed.
setEventsToSaveRule(OpenMetadataExchangeRule) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the enumeration describing which open metadata repository events should be saved to the local repository.
setEventsToSendRule(OpenMetadataExchangeRule) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the enumeration describing which open metadata repository events should be sent from the local repository.
setLocalRepositoryConfig(LocalRepositoryConfig) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Set up the configuration properties for the local repository.
setLocalRepositoryLocalConnection(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the connection properties used to create a locally optimized connector to the local repository for use by this local server's components.
setLocalRepositoryRemoteConnection(Connection) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the connection properties used to create a connector to the local repository for use by remote servers.
setLocalServerName(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the name of the local server.
setLocalServerType(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the descriptive name for the server type.
setLocalServerURL(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the base URL for calling the local server.
setLocalServerUserId(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the userId that the local server should use when processing events and there is no external user driving the operation.
setMaxPageSize(int) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the maximum page size supported by this server.
setMetadataCollectionId(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the unique id of local repository's metadata collection.
setOpenMetadataArchiveConnections(List<Connection>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.RepositoryServicesConfig: Set up the list of Connection object, each of which is used to create the Connector to an Open Metadata Archive.
setOrganizationName(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the name of the organization that is running the server.
setRepositoryServicesConfig(RepositoryServicesConfig) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig: Set up the Open Metadata Repository Services (OMRS) config.
setSelectedTypesToProcess(List<TypeDefSummary>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig: Set up the list of TypeDefs used if the EventsToProcess rule (above) says "SELECTED_TYPES" - otherwise it is set to null.
setSelectedTypesToSave(List<TypeDefSummary>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the list of TypeDefs in supported of the eventsToSave.SELECTED_TYPES option.
setSelectedTypesToSend(List<TypeDefSummary>) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig: Set up the list of TypeDefs in supported of the eventsToSend.SELECTED_TYPES option.
setTopicURLRoot(String) - Method in class org.odpi.openmetadata.adminservices.configuration.properties.EventBusConfig: Set up the root of the topic URL.
shutdown() - Method in interface org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceAdmin: Shutdown the access service.

T

toString() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataEventProtocolVersion: Standard toString method.
toString() - Method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataExchangeRule: Standard toString method.

V

valueOf(String) - Static method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataEventProtocolVersion: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataExchangeRule: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceOperationalStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.odpi.openmetadata.adminservices.OMAGServiceMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataEventProtocolVersion: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.odpi.openmetadata.adminservices.configuration.properties.OpenMetadataExchangeRule: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceOperationalStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.odpi.openmetadata.adminservices.OMAGServiceMode: Returns an array containing the constants of this enum type, in the order they are declared.

A C E G I L O R S T V