Index (Administration Services Server-side 1.4 API)

A C D E G O R S V

A

activateServerListWithStoredConfig(String, List<String>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Activate the list of open metadata and governance servers using the stored configuration information.
activateWithStoredConfig(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Activate the open metadata and governance services using the stored configuration information.
activateWithSuppliedConfig(String, String, OMAGServerConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Activate the open metadata and governance services using the supplied configuration document.
addAuditLogDestination(String, String, Connection) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the list of audit log destinations.
addConsoleAuditLogDestination(String, String, List<String>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the console (stdout) audit log destination for the server.
addEventTopicAuditLogDestination(String, String, List<String>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the File based audit log destination for the server.
addFileAuditLogDestination(String, String, List<String>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the File based audit log destination for the server.
addOpenMetadataArchiveFile(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Add a new open metadata archive to running repository.
addSLF4JAuditLogDestination(String, String, List<String>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the SLF4J audit log destination for the server.
addStartUpOpenMetadataArchiveFile(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Add a new open metadata archive to load at startup.

C

captureConfigurationErrorException(FFDCResponseBase, OMAGConfigurationErrorException) - Method in class org.odpi.openmetadata.adminservices.OMAGServerExceptionHandler: Set the exception information into the response.
captureNotAuthorizedException(FFDCResponseBase, OMAGNotAuthorizedException) - Method in class org.odpi.openmetadata.adminservices.OMAGServerExceptionHandler: Set the exception information into the response.
captureRuntimeException(String, String, FFDCResponseBase, Throwable) - Method in class org.odpi.openmetadata.adminservices.OMAGServerExceptionHandler: Set the exception information into the response.
captureRuntimeException(String, FFDCResponseBase, Throwable) - Method in class org.odpi.openmetadata.adminservices.OMAGServerExceptionHandler: Set the exception information into the response.
clearAuditLogDestinations(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the list of audit log destinations.
clearConfigurationStoreConnection(String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminStoreServices: Clear the connection object for the configuration store.
clearPlatformSecurityConnection(String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminSecurityServices: Clear the connection object for the platform security connector.
clearServerSecurityConnection(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminSecurityServices: Clear the connection object for the server security connector.
configureAccessService(String, String, String, Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices: Enable a single access service.

D

deactivatePermanently(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Terminate any running open metadata and governance services, remove the server from any open metadata cohorts and delete the server's configuration.
deactivateTemporarily(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Temporarily deactivate any open metadata and governance services for the requested server.
deactivateTemporarilyServerList(String, List<String>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Temporarily deactivate the open metadata and governance servers in th supplied list.
deleteDataEngineProxy(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerDataEngineProxyService: Remove Data Engine Proxy from the server configuration.
deleteService(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigDiscoveryServer: Remove this service from the server configuration.
deleteService(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigStewardshipServices: Remove this service from the server configuration.
deployOMAGServerConfig(String, String, URLRequestBody) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Push the configuration for the server to another OMAG Server Platform.
disableAccessServices(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices: Disable the access services.
disableAllConformanceSuiteWorkbenches(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGConformanceSuiteConfigServices: Request that all of the conformance suite tests are deactivated in this server.
disableCohortRegistration(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the mode for an open metadata repository cohort.
disablePlatformConformanceSuiteServices(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGConformanceSuiteConfigServices: Request that the repository conformance suite tests are deactivated in this server.
disableRepositoryConformanceSuiteServices(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGConformanceSuiteConfigServices: Request that the repository conformance suite tests are deactivated in this server.

E

enableAccessServices(String, String, Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices: Enable all access services that are installed into this server.
enableCohortRegistration(String, String, String, Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Enable registration of server to an open metadata repository cohort.
enableDataPlatformService(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerDataPlatformService
enablePlatformConformanceSuiteWorkbench(String, String, URLRequestBody) - Method in class org.odpi.openmetadata.adminservices.OMAGConformanceSuiteConfigServices: Request that the platform conformance suite workbench is activated in this server to test the support of the platform services running in the platform at tutPlatformRootURL.
enableRepositoryConformanceSuiteWorkbench(String, String, RepositoryConformanceWorkbenchConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGConformanceSuiteConfigServices: Request that the repository conformance suite workbench is activated in this server to test the support of the repository services running in the server named tutRepositoryServerName.
enableSecurityOfficerService(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerSecurityOfficerService
enableSecuritySyncService(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerSecuritySyncService
enableVirtualizationService(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerVirtualizationService

G

getActiveConfiguration(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices: Return the complete set of configuration properties in use by the server.
getConfigurationStoreConnection(String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminStoreServices: Return the connection object for the configuration store.
getConfiguredAccessServices(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices: Return the list of access services that are configured for this server.
getFormattedLogMessage(String...) - Method in enum org.odpi.openmetadata.adminservices.auditlog.OMAGAdminAuditCode: Returns the log message with the placeholders filled out with the supplied parameters.
getLocalMetadataCollectionId(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Return the local metadata collection id.
getLogMessageId() - Method in enum org.odpi.openmetadata.adminservices.auditlog.OMAGAdminAuditCode: Returns the unique identifier for the error message.
getOperationalOCFMetadataServices() - Method in class org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance: Return the running instance of the Open Connector Framework (OCF) metadata services.
getOperationalSecurityOfficerService() - Method in class org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance: Return the running instance of the Security Officer Server
getPlatformSecurityConnection(String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminSecurityServices: Return the connection object for the platform security connector.
getServerOrigin(String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOriginServices: Return the origin of this server implementation.
getServerSecurityConnection(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminSecurityServices: Return the connection object for the server security connector.
getServerServiceInstance(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerOperationalInstanceHandler: Get the object containing the properties for this server.
getSeverity() - Method in enum org.odpi.openmetadata.adminservices.auditlog.OMAGAdminAuditCode: Return the severity of the audit log record.
getStoredConfiguration(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Return the complete set of configuration properties in use by the server.
getSystemAction() - Method in enum org.odpi.openmetadata.adminservices.auditlog.OMAGAdminAuditCode: Returns a description of the action taken by the system when the condition that caused this exception was detected.
getUserAction() - Method in enum org.odpi.openmetadata.adminservices.auditlog.OMAGAdminAuditCode: Returns instructions of how to resolve the issue reported in this exception.

O

OMAGAdminAuditCode - Enum in org.odpi.openmetadata.adminservices.auditlog: The OMAGAdminAuditCode is used to define the message content for the OMRS Audit Log.
OMAGConformanceSuiteConfigServices - Class in org.odpi.openmetadata.adminservices: OMAGConformanceSuiteConfigServices configures the Open Metadata Conformance Suite workbenches in an OMAG Server.
OMAGConformanceSuiteConfigServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGConformanceSuiteConfigServices
OMAGOperationalServicesInstance - Class in org.odpi.openmetadata.adminservices: OMAGOperationalServicesInstance provides the references to the active services for an instance of an OMAG Server.
OMAGOperationalServicesInstance(String, String) - Constructor for class org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance: Deprecated.
OMAGOperationalServicesInstance(String, String, int) - Constructor for class org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance: Default constructor
OMAGServerAdminForAccessServices - Class in org.odpi.openmetadata.adminservices: OMAGServerAdminForAccessServices provides the server-side support for the services that add access services configuration to an OMAG Server.
OMAGServerAdminForAccessServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices: Default constructor
OMAGServerAdminSecurityServices - Class in org.odpi.openmetadata.adminservices: OMAGServerAdminSecurityServices provides the capability to set up open metadata security connectors.
OMAGServerAdminSecurityServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerAdminSecurityServices
OMAGServerAdminServices - Class in org.odpi.openmetadata.adminservices: OMAGServerAdminServices provides part of the server-side implementation of the administrative interface for an Open Metadata and Governance (OMAG) Server.
OMAGServerAdminServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerAdminServices
OMAGServerAdminStoreServices - Class in org.odpi.openmetadata.adminservices: OMAGServerAdminStoreServices provides the capability to store and retrieve configuration documents.
OMAGServerAdminStoreServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerAdminStoreServices
OMAGServerConfigDiscoveryServer - Class in org.odpi.openmetadata.adminservices: OMAGServerConfigDiscoveryServer supports the configuration requests for a discovery server and the discovery engines that run inside of it.
OMAGServerConfigDiscoveryServer() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerConfigDiscoveryServer
OMAGServerConfigOpenLineage - Class in org.odpi.openmetadata.adminservices
OMAGServerConfigOpenLineage() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerConfigOpenLineage
OMAGServerConfigStewardshipServices - Class in org.odpi.openmetadata.adminservices: OMAGServerConfigStewardshipServices supports the configuration requests for the stewardship services.
OMAGServerConfigStewardshipServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerConfigStewardshipServices
OMAGServerDataEngineProxyService - Class in org.odpi.openmetadata.adminservices: OMAGServerDataEngineProxyService supports the configuration requests for Data Engine Proxies.
OMAGServerDataEngineProxyService() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerDataEngineProxyService
OMAGServerDataPlatformService - Class in org.odpi.openmetadata.adminservices
OMAGServerDataPlatformService() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerDataPlatformService
OMAGServerExceptionHandler - Class in org.odpi.openmetadata.adminservices: OMAGServerExceptionHandler provides common error handling routines for the admin services
OMAGServerExceptionHandler() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerExceptionHandler: Default constructor
OMAGServerOperationalInstanceHandler - Class in org.odpi.openmetadata.adminservices: OMAGServerServiceInstanceHandler retrieves information from the instance map for an OMAG server service instance.
OMAGServerOperationalInstanceHandler(String) - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerOperationalInstanceHandler: Constructor passes the service name that is used on all calls to this instance.
OMAGServerOperationalServices - Class in org.odpi.openmetadata.adminservices: OMAGServerOperationalServices will provide support to start, manage and stop services in the OMAG Server.
OMAGServerOperationalServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerOperationalServices
OMAGServerOriginServices - Class in org.odpi.openmetadata.adminservices: OMAGServerPlatformOriginServices support the origin services for Egeria's OMAG Server.
OMAGServerOriginServices() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerOriginServices
OMAGServerSecurityOfficerService - Class in org.odpi.openmetadata.adminservices
OMAGServerSecurityOfficerService() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerSecurityOfficerService
OMAGServerSecuritySyncService - Class in org.odpi.openmetadata.adminservices
OMAGServerSecuritySyncService() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerSecuritySyncService
OMAGServerVirtualizationService - Class in org.odpi.openmetadata.adminservices
OMAGServerVirtualizationService() - Constructor for class org.odpi.openmetadata.adminservices.OMAGServerVirtualizationService
org.odpi.openmetadata.adminservices - package org.odpi.openmetadata.adminservices
org.odpi.openmetadata.adminservices.auditlog - package org.odpi.openmetadata.adminservices.auditlog

R

removeOpenLineageConfig(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigOpenLineage: Remove this service from the server configuration.

S

setAccessServiceRootURL(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigDiscoveryServer: Set up the root URL of the access service.
setAccessServiceRootURL(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigStewardshipServices: Set up the root URL of the access service.
setAccessServicesConfig(String, String, List<AccessServiceConfig>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices: Set up the configuration for all of the open metadata access services (OMASs).
setAccessServiceServerName(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigDiscoveryServer: Set up the server name of the access service.
setAccessServiceServerName(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigStewardshipServices: Set up the server name of the access service.
setAuditLogDestinations(String, String, List<Connection>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the list of audit log destinations.
setCohortConfig(String, String, String, CohortConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the configuration properties for a cohort.
setConfigurationStoreConnection(String, Connection) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminStoreServices: Override the default location of the configuration documents.
setDataEngineProxyConfig(String, String, DataEngineProxyConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerDataEngineProxyService: Store the provided Data Engine Proxy configuration
setDataPlatformServiceConfig(String, String, DataPlatformServicesConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerDataPlatformService
setDefaultAuditLog(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the default audit log for the server.
setDiscoveryEngines(String, String, List<String>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigDiscoveryServer: Set up the list of discovery engines that will run in this discovery server.
setEnterpriseAccessConfig(String, String, EnterpriseAccessConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices: Set up the configuration that controls the enterprise repository services.
setEventBus(String, String, String, String, Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the default event bus for embedding in event-driven connector.
setGraphLocalRepository(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up a graph store as the local repository.
setInboundRequestConnection(String, String, Connection) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigStewardshipServices: Set up the server name of the access service.
setInMemLocalRepository(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up an in memory local repository.
setLocalMetadataCollectionName(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the local metadata collection name.
setLocalRepositoryConfig(String, String, LocalRepositoryConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the configuration for the local repository.
setLocalRepositoryEventMapper(String, String, Connection) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Provide the connection to the local repository's event mapper if needed.
setLocalRepositoryEventMapper(String, String, String, String, Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Provide the connection to the local repository's event mapper if needed.
setMaxPageSize(String, String, int) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set an upper limit in the page size that can be requested on a REST call to the server.
setNoRepositoryMode(String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Remove all configuration for a local repository.
setOMAGServerConfig(String, String, OMAGServerConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the configuration properties for an OMAG Server in a single command.
setOpenLineageConfig(String, String, OpenLineageServerConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerConfigOpenLineage: Set the Open Lineage Config
setOpenMetadataArchives(String, String, List<Connection>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the list of open metadata archives.
setOperationalOCFMetadataServices(OCFMetadataOperationalServices) - Method in class org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance: Set up the running instance of the Open Connector Framework (OCF) metadata services.
setOperationalSecurityOfficerService(SecurityOfficerOperationalServices) - Method in class org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance: Set up the running instance of the Security Officer Server
setOrganizationName(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the name of the organization that is running this server.
setPlatformSecurityConnection(String, PlatformSecurityRequestBody) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminSecurityServices: Override the default platform security connector.
setRepositoryProxyConnection(String, String, Connection) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
setRepositoryProxyConnection(String, String, String, Map<String, Object>) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Provide the connection to the local repository.
setSecurityOfficerConfig(String, String, SecurityOfficerConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerSecurityOfficerService
setSecuritySyncConfig(String, String, SecuritySyncConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerSecuritySyncService
setServerPassword(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the user id to use when there is no external user driving the work (for example when processing events from another server).
setServerSecurityConnection(String, String, Connection) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminSecurityServices: Override the default server security connector.
setServerType(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the descriptive type of the server.
setServerURLRoot(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces that is used by other members of the cohorts that this server connects to.
setServerUserId(String, String, String) - Method in class org.odpi.openmetadata.adminservices.OMAGServerAdminServices: Set up the user id to use when there is no external user driving the work (for example when processing events from another server).
setVirtualizerConfig(String, String, VirtualizationConfig) - Method in class org.odpi.openmetadata.adminservices.OMAGServerVirtualizationService

V

valueOf(String) - Static method in enum org.odpi.openmetadata.adminservices.auditlog.OMAGAdminAuditCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.adminservices.auditlog.OMAGAdminAuditCode: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G O R S V