Package org.odpi.openmetadata.commonservices.multitenant

Class AccessServerServiceInstance

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstance

org.odpi.openmetadata.commonservices.multitenant.AccessServerServiceInstance

Direct Known Subclasses:

GAFServicesInstance, OCFServicesInstance, OIFServicesInstance, OMFServicesInstance

public class AccessServerServiceInstance
extends AuditableServerServiceInstance

AccessServerServiceInstance caches references to OMRS objects for a specific Metadata Access Store. It is also responsible for registering itself in the instance map.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	defaultZones
protected RepositoryErrorHandler	errorHandler
protected OMRSMetadataCollection	metadataCollection
protected List<String>	publishZones
protected OMRSRepositoryConnector	repositoryConnector
protected RepositoryHandler	repositoryHandler
protected OMRSRepositoryHelper	repositoryHelper
protected List<String>	supportedZones

Fields inherited from class org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstance

auditLog, localServerUserId

Fields inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance

invalidParameterHandler, maxPageSize, securityVerifier, serverName, serviceName

Constructor Summary

Constructors

Constructor	Description
AccessServerServiceInstance(String serviceName, OMRSRepositoryConnector repositoryConnector, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog, String localServerUserId, int maxPageSize)	Set up the local repository connector that will service the REST Calls.
AccessServerServiceInstance(String serviceName, OMRSRepositoryConnector repositoryConnector, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog, String localServerUserId, int maxPageSize, String outTopicConnectorProviderName, Connection outTopicEventBusConnection)	Set up the local repository connector that will service the REST Calls.
AccessServerServiceInstance(String serviceName, OMRSRepositoryConnector repositoryConnector, AuditLog auditLog, String localServerUserId, int maxPageSize)	Set up the local repository connector that will service the REST Calls.

Method Summary

Modifier and Type	Method	Description
RegisteredOMAGService	getRegisteredOMAGService(int accessServiceCode)
String	getServerName()	Return the server name.
protected void	validateActiveRepository(String methodName)	Validate that the repository services are ok for this instance.

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstance

getAuditLog

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance

getInvalidParameterHandler, getServiceInstanceStatus, getServiceName, setMaxPageSize, setSecurityVerifier, setServerName, setServiceInstanceStatus, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

repositoryConnector

protected OMRSRepositoryConnector repositoryConnector

metadataCollection

protected OMRSMetadataCollection metadataCollection

repositoryHelper

protected OMRSRepositoryHelper repositoryHelper

repositoryHandler

protected RepositoryHandler repositoryHandler

errorHandler

protected RepositoryErrorHandler errorHandler

supportedZones

protected List<String> supportedZones

defaultZones

protected List<String> defaultZones

publishZones

protected List<String> publishZones

Constructor Details

AccessServerServiceInstance

public AccessServerServiceInstance(String serviceName,
 OMRSRepositoryConnector repositoryConnector,
 AuditLog auditLog,
 String localServerUserId,
 int maxPageSize)
                            throws NewInstanceException

Set up the local repository connector that will service the REST Calls.

Parameters:

serviceName - name of this service

repositoryConnector - link to the repository responsible for servicing the REST calls.

auditLog - logging destination

localServerUserId - userId used for server initiated actions

maxPageSize - maximum page size

Throws:

NewInstanceException - a problem occurred during initialization

AccessServerServiceInstance

public AccessServerServiceInstance(String serviceName,
 OMRSRepositoryConnector repositoryConnector,
 List<String> supportedZones,
 List<String> defaultZones,
 List<String> publishZones,
 AuditLog auditLog,
 String localServerUserId,
 int maxPageSize)
                            throws NewInstanceException

Set up the local repository connector that will service the REST Calls.

Parameters:

serviceName - name of this service

repositoryConnector - link to the repository responsible for servicing the REST calls.

supportedZones - list of zones that access service is allowed to serve Assets from.

defaultZones - list of zones that access service should set in all new Assets.

publishZones - list of zones that the access service sets up in published Asset instances.

auditLog - logging destination

localServerUserId - userId used for server initiated actions

maxPageSize - maximum page size

Throws:

NewInstanceException - a problem occurred during initialization

AccessServerServiceInstance

public AccessServerServiceInstance(String serviceName,
 OMRSRepositoryConnector repositoryConnector,
 List<String> supportedZones,
 List<String> defaultZones,
 List<String> publishZones,
 AuditLog auditLog,
 String localServerUserId,
 int maxPageSize,
 String outTopicConnectorProviderName,
 Connection outTopicEventBusConnection)
                            throws NewInstanceException

Set up the local repository connector that will service the REST Calls.

Parameters:

serviceName - name of this service

repositoryConnector - link to the repository responsible for servicing the REST calls.

supportedZones - list of zones that access service is allowed to serve Assets from.

defaultZones - list of zones that access service should set in all new Assets.

publishZones - list of zones that the access service sets up in published Asset instances.

auditLog - logging destination

localServerUserId - userId used for server initiated actions

maxPageSize - maximum page size

outTopicConnectorProviderName - class name of the client side out topic connector

outTopicEventBusConnection - connection for the event bus configured with the out topic

Throws:

NewInstanceException - a problem occurred during initialization

Method Details

getServerName

public String getServerName()
                     throws NewInstanceException

Return the server name. Used during OMAS initialization which is why the exception is different.

Overrides:

getServerName in class OMAGServerServiceInstance

Returns:

serverName name of the server for this instance

Throws:

NewInstanceException - a problem occurred during initialization

getRegisteredOMAGService

public RegisteredOMAGService getRegisteredOMAGService(int accessServiceCode)

validateActiveRepository

protected void validateActiveRepository(String methodName)
                                 throws PropertyServerException

Validate that the repository services are ok for this instance.

Parameters:

methodName - calling method

Throws:

PropertyServerException - problem with the repository services