org.odpi.openmetadata.commonservices.multitenant

Class OCFOMASServiceInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.OMASServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.OCFOMASServiceInstanceHandler

Direct Known Subclasses:

ODFOMASServiceInstanceHandler

public abstract class OCFOMASServiceInstanceHandler
extends OMASServiceInstanceHandler

Provide access to the common handlers for OMAS's that use the OCF beans.

Field Summary

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

platformInstanceMap, serviceName

Constructor Summary

Constructors

Constructor and Description
OCFOMASServiceInstanceHandler(String serviceName) Constructor

Method Summary

Modifier and Type	Method and Description
AssetHandler	getAssetHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
CertificationHandler	getCertificationHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
CommentHandler	getCommentHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
ConnectionHandler	getConnectionHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
ConnectorTypeHandler	getConnectorTypeHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
List<String>	getDefaultZones(String userId, String serverName, String callingServiceURLName, String serviceOperationName) Get the defaultZones for a specific service.
EndpointHandler	getEndpointHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
ExternalIdentifierHandler	getExternalIdentifierHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
ExternalReferenceHandler	getExternalReferenceHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
FilesAndFoldersHandler	getFilesAndFoldersHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
GlossaryTermHandler	getGlossaryTermHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
InformalTagHandler	getInformalTagHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
LicenseHandler	getLicenseHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
LikeHandler	getLikeHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
LocationHandler	getLocationHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
MeaningHandler	getMeaningHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
NoteHandler	getNoteHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
NoteLogHandler	getNoteLogHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
List<String>	getPublishZones(String userId, String serverName, String callingServiceURLName, String serviceOperationName) Get the publish for a specific service.
RatingHandler	getRatingHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
ReferenceableHandler	getReferenceableHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
RelatedMediaHandler	getRelatedMediaHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
RelationalDataHandler	getRelationalDataHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
SchemaTypeHandler	getSchemaTypeHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
String	getServiceName(String callingServiceURLName) Return the service's official name
SoftwareServerCapabilityHandler	getSoftwareServerCapabilityHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.
List<String>	getSupportedZones(String userId, String serverName, String callingServiceURLName, String serviceOperationName) Get the supportedZones for a specific service.
ValidValuesHandler	getValidValuesHandler(String userId, String serverName, String serviceOperationName) Retrieve the specific handler for the access service.

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

getDefaultZones, getErrorHandler, getExceptionHandler, getMetadataCollection, getPublishZones, getRepositoryConnector, getRepositoryHandler, getSupportedZones

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

getAuditLog

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

getServerSecurityVerifier, getServerServiceInstance, getServiceName, isServerActive, removeServerServiceInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

OCFOMASServiceInstanceHandler

public OCFOMASServiceInstanceHandler(String serviceName)

Constructor

Parameters:

serviceName - name of the service

Method Detail

getServiceName

public String getServiceName(String callingServiceURLName)

Return the service's official name

Parameters:

callingServiceURLName - url fragment that indicates the service name

Returns:

String name

getSupportedZones

public List<String> getSupportedZones(String userId,
                                      String serverName,
                                      String callingServiceURLName,
                                      String serviceOperationName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Get the supportedZones for a specific service. This is used in services that are shared by different access services.

Parameters:

userId - calling user

serverName - name of this server

callingServiceURLName - url fragment that indicates the service name

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

list of governance zones

Throws:

InvalidParameterException - the server name is not known

UserNotAuthorizedException - the user is not authorized to issue the request.

PropertyServerException - the service name is not known - indicating a logic error

getDefaultZones

public List<String> getDefaultZones(String userId,
                                    String serverName,
                                    String callingServiceURLName,
                                    String serviceOperationName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Get the defaultZones for a specific service. This is used in services that are shared by different access services.

Parameters:

userId - calling user

serverName - name of this server

callingServiceURLName - url fragment that indicates the service name

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

list of governance zones

Throws:

InvalidParameterException - the server name is not known

UserNotAuthorizedException - the user is not authorized to issue the request.

PropertyServerException - the service name is not known - indicating a logic error

getPublishZones

public List<String> getPublishZones(String userId,
                                    String serverName,
                                    String callingServiceURLName,
                                    String serviceOperationName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Get the publish for a specific service. This is used in services that are shared by different access services.

Parameters:

userId - calling user

serverName - name of this server

callingServiceURLName - url fragment that indicates the service name

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

list of governance zones

Throws:

InvalidParameterException - the server name is not known

UserNotAuthorizedException - the user is not authorized to issue the request.

PropertyServerException - the service name is not known - indicating a logic error

getAssetHandler

public AssetHandler getAssetHandler(String userId,
                                    String serverName,
                                    String serviceOperationName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getCertificationHandler

public CertificationHandler getCertificationHandler(String userId,
                                                    String serverName,
                                                    String serviceOperationName)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getCommentHandler

public CommentHandler getCommentHandler(String userId,
                                        String serverName,
                                        String serviceOperationName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getConnectionHandler

public ConnectionHandler getConnectionHandler(String userId,
                                              String serverName,
                                              String serviceOperationName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getConnectorTypeHandler

public ConnectorTypeHandler getConnectorTypeHandler(String userId,
                                                    String serverName,
                                                    String serviceOperationName)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getEndpointHandler

public EndpointHandler getEndpointHandler(String userId,
                                          String serverName,
                                          String serviceOperationName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getExternalIdentifierHandler

public ExternalIdentifierHandler getExternalIdentifierHandler(String userId,
                                                              String serverName,
                                                              String serviceOperationName)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getExternalReferenceHandler

public ExternalReferenceHandler getExternalReferenceHandler(String userId,
                                                            String serverName,
                                                            String serviceOperationName)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getFilesAndFoldersHandler

public FilesAndFoldersHandler getFilesAndFoldersHandler(String userId,
                                                        String serverName,
                                                        String serviceOperationName)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getGlossaryTermHandler

public GlossaryTermHandler getGlossaryTermHandler(String userId,
                                                  String serverName,
                                                  String serviceOperationName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getInformalTagHandler

public InformalTagHandler getInformalTagHandler(String userId,
                                                String serverName,
                                                String serviceOperationName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getLicenseHandler

public LicenseHandler getLicenseHandler(String userId,
                                        String serverName,
                                        String serviceOperationName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getLikeHandler

public LikeHandler getLikeHandler(String userId,
                                  String serverName,
                                  String serviceOperationName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getLocationHandler

public LocationHandler getLocationHandler(String userId,
                                          String serverName,
                                          String serviceOperationName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getMeaningHandler

public MeaningHandler getMeaningHandler(String userId,
                                        String serverName,
                                        String serviceOperationName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getNoteHandler

public NoteHandler getNoteHandler(String userId,
                                  String serverName,
                                  String serviceOperationName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getNoteLogHandler

public NoteLogHandler getNoteLogHandler(String userId,
                                        String serverName,
                                        String serviceOperationName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getRatingHandler

public RatingHandler getRatingHandler(String userId,
                                      String serverName,
                                      String serviceOperationName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getReferenceableHandler

public ReferenceableHandler getReferenceableHandler(String userId,
                                                    String serverName,
                                                    String serviceOperationName)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getRelatedMediaHandler

public RelatedMediaHandler getRelatedMediaHandler(String userId,
                                                  String serverName,
                                                  String serviceOperationName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getRelationalDataHandler

public RelationalDataHandler getRelationalDataHandler(String userId,
                                                      String serverName,
                                                      String serviceOperationName)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getSchemaTypeHandler

public SchemaTypeHandler getSchemaTypeHandler(String userId,
                                              String serverName,
                                              String serviceOperationName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getSoftwareServerCapabilityHandler

public SoftwareServerCapabilityHandler getSoftwareServerCapabilityHandler(String userId,
                                                                          String serverName,
                                                                          String serviceOperationName)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server

getValidValuesHandler

public ValidValuesHandler getValidValuesHandler(String userId,
                                                String serverName,
                                                String serviceOperationName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Retrieve the specific handler for the access service.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - error in the requested server