Package org.odpi.openmetadata.commonservices.multitenant

Class OMAGServerServiceInstance

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance

Direct Known Subclasses:

AuditableServerServiceInstance, DataEngineProxyServerInstance, LineageWarehouseServerInstance, OMAGOperationalServicesInstance, OMRSRepositoryServicesInstance

public abstract class OMAGServerServiceInstance
extends Object

OMAGServerServiceInstance represents an instance of a service in an OMAG Server. It is also responsible for registering itself in the instance map.

Field Summary

Fields

Modifier and Type	Field	Description
protected InvalidParameterHandler	invalidParameterHandler
protected int	maxPageSize
protected OpenMetadataServerSecurityVerifier	securityVerifier
protected String	serverName
protected String	serviceName

Constructor Summary

Constructors

Constructor	Description
OMAGServerServiceInstance(String serverName, String serviceName, int maxPageSize)	Default constructor
OMAGServerServiceInstance(String serverName, String serverType, String serviceName, int maxPageSize)	Default constructor

Method Summary

Modifier and Type	Method	Description
InvalidParameterHandler	getInvalidParameterHandler()	Return the handler for validating parameters.
String	getServerName()	Return the server name.
ServerInstanceStatus	getServiceInstanceStatus()	Return the current status of the service.
String	getServiceName()	Return this service's official name.
void	setMaxPageSize(int maxPageSize)	Override the default maximum paging size.
void	setSecurityVerifier(OpenMetadataServerSecurityVerifier securityVerifier)	Set up a new security verifier (the handler runs with a default verifier until this method is called).
protected void	setServerName(String serverName)	Set the server name.
void	setServiceInstanceStatus(ServerInstanceStatus serviceInstanceStatus)	Set up the current status of the service.
void	shutdown()	Unregister this instance from the instance map.

Methods inherited from class java.lang.Object

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

Field Details

serverName

protected String serverName

serviceName

protected String serviceName

maxPageSize

protected int maxPageSize

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

securityVerifier

protected OpenMetadataServerSecurityVerifier securityVerifier

Constructor Details

OMAGServerServiceInstance

public OMAGServerServiceInstance(String serverName,
 String serverType,
 String serviceName,
 int maxPageSize)

Default constructor

Parameters:

serverName - name of the new server

serverType - type for new server

serviceName - name of the new service instance

maxPageSize - maximum number of results that can be returned on a single call.

OMAGServerServiceInstance

public OMAGServerServiceInstance(String serverName,
 String serviceName,
 int maxPageSize)

Default constructor

Parameters:

serverName - name of the new server

serviceName - name of the new service instance

maxPageSize - maximum number of results that can be returned on a single call.

Method Details

setServerName

protected void setServerName(String serverName)

Set the server name.

Parameters:

serverName - name of this OMAG server

setServiceInstanceStatus

public void setServiceInstanceStatus(ServerInstanceStatus serviceInstanceStatus)

Set up the current status of the service.

Parameters:

serviceInstanceStatus - new status

getServiceInstanceStatus

public ServerInstanceStatus getServiceInstanceStatus()

Return the current status of the service.

Returns:

server instance status enum

setSecurityVerifier

public void setSecurityVerifier(OpenMetadataServerSecurityVerifier securityVerifier)

Set up a new security verifier (the handler runs with a default verifier until this method is called). The security verifier provides authorization checks for access and maintenance changes to open metadata. Authorization checks are enabled through the OpenMetadataServerSecurityConnector.

Parameters:

securityVerifier - new security verifier

setMaxPageSize

public void setMaxPageSize(int maxPageSize)

Override the default maximum paging size.

Parameters:

maxPageSize - new value

getServerName

public String getServerName()
                     throws NewInstanceException

Return the server name.

Returns:

serverName name of the server for this instance

Throws:

NewInstanceException - a problem occurred during initialization

getServiceName

public String getServiceName()

Return this service's official name.

Returns:

name

getInvalidParameterHandler

public InvalidParameterHandler getInvalidParameterHandler()

Return the handler for validating parameters.

Returns:

invalid parameter handler

shutdown

public void shutdown()

Unregister this instance from the instance map.