Package org.odpi.openmetadata.viewservices.glossarybrowser.server

Class GlossaryBrowserInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.OMVSServiceInstanceHandler

org.odpi.openmetadata.viewservices.glossarybrowser.server.GlossaryBrowserInstanceHandler

public class GlossaryBrowserInstanceHandler
extends org.odpi.openmetadata.commonservices.multitenant.OMVSServiceInstanceHandler

GlossaryBrowserInstanceHandler retrieves information from the instance map for the view service instances. The instance map is thread-safe. Instances are added and removed by the GlossaryBrowserAdmin class.

Constructor Summary

Constructors

Constructor	Description
GlossaryBrowserInstanceHandler()	Default constructor registers the view service

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.accessservices.assetmanager.client.management.CollaborationManagementClient	getCollaborationManagementClient(String userId, String serverName, String serviceOperationName)	This method returns the object for the tenant to use to work with the asset manager API
String	getEndsWithRegex(String searchString, boolean insensitive)	Retrieve an escaped version of the provided string that can be passed to methods that expect regular expressions, to search for the string with an "ends with" semantic.
org.odpi.openmetadata.accessservices.assetmanager.client.management.GlossaryManagementClient	getGlossaryManagementClient(String userId, String serverName, String serviceOperationName)	This method returns the object for the tenant to use to work with the asset manager API
String	getSearchString(String requestedSearch, boolean startsWith, boolean endsWith, boolean ignoreCase)	Construct a regular expression from the string supplied by the caller.
String	getStartsWithRegex(String searchString, boolean insensitive)	Retrieve an escaped version of the provided string that can be passed to methods that expect regular expressions, to search for the string with a "starts with" semantic.
org.odpi.openmetadata.accessservices.assetmanager.client.management.StewardshipManagementClient	getStewardshipManagementClient(String userId, String serverName, String serviceOperationName)	This method returns the object for the tenant to use to work with the asset manager API

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

getExceptionHandler

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

getAuditLog

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

getServerSecurityVerifier, getServiceName, isServerActive, removeServerServiceInstance

Methods inherited from class java.lang.Object

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

Constructor Details

GlossaryBrowserInstanceHandler

public GlossaryBrowserInstanceHandler()

Default constructor registers the view service

Method Details

getStartsWithRegex

public String getStartsWithRegex(String searchString,
 boolean insensitive)

Retrieve an escaped version of the provided string that can be passed to methods that expect regular expressions, to search for the string with a "starts with" semantic. The passed string will NOT be treated as a regular expression; if you intend to use both a "starts with" semantic and a regular expression within the string, simply construct your own regular expression directly (not with this helper method).

Parameters:

searchString - the string to escape to avoid being interpreted as a regular expression, but also wrap to obtain a "starts with" semantic

insensitive - set to true to have a case-insensitive "starts with" regular expression

Returns:

string that is interpreted literally, wrapped for a "starts with" semantic

getEndsWithRegex

public String getEndsWithRegex(String searchString,
 boolean insensitive)

Retrieve an escaped version of the provided string that can be passed to methods that expect regular expressions, to search for the string with an "ends with" semantic. The passed string will NOT be treated as a regular expression; if you intend to use both an "ends with" semantic and a regular expression within the string, simply construct your own regular expression directly (not with this helper method).

Parameters:

searchString - the string to escape to avoid being interpreted as a regular expression, but also wrap to obtain an "ends with" semantic

insensitive - set to true to have a case-insensitive "ends with" regular expression

Returns:

string that is interpreted literally, wrapped for an "ends with" semantic

getSearchString

public String getSearchString(String requestedSearch,
 boolean startsWith,
 boolean endsWith,
 boolean ignoreCase)

Construct a regular expression from the string supplied by the caller. If their string includes regular expression characters then they will be ignored.

Parameters:

requestedSearch - the supplied string

startsWith - set to true if the requested string is at the front of the search

endsWith - set to true if the requested string is at the end of the search

ignoreCase - set to true to have a case-insensitive search

Returns:

string that is interpreted literally rather than as a regular expression

getCollaborationManagementClient

public org.odpi.openmetadata.accessservices.assetmanager.client.management.CollaborationManagementClient getCollaborationManagementClient(String userId,
 String serverName,
 String serviceOperationName)
                                                                                                                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

This method returns the object for the tenant to use to work with the asset manager API

Parameters:

serverName - name of the server that the request is for

userId - local server userid

serviceOperationName - service operation - usually the top level rest call

Returns:

SubjectAreaNodeClients subject area nodes API objects

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - unknown server/service

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - User not authorized to call this service

org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException - internal error

getGlossaryManagementClient

public org.odpi.openmetadata.accessservices.assetmanager.client.management.GlossaryManagementClient getGlossaryManagementClient(String userId,
 String serverName,
 String serviceOperationName)
                                                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

This method returns the object for the tenant to use to work with the asset manager API

Parameters:

serverName - name of the server that the request is for

userId - local server userid

serviceOperationName - service operation - usually the top level rest call

Returns:

SubjectAreaNodeClients subject area nodes API objects

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - unknown server/service

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - User not authorized to call this service

org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException - internal error

getStewardshipManagementClient

public org.odpi.openmetadata.accessservices.assetmanager.client.management.StewardshipManagementClient getStewardshipManagementClient(String userId,
 String serverName,
 String serviceOperationName)
                                                                                                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

This method returns the object for the tenant to use to work with the asset manager API

Parameters:

serverName - name of the server that the request is for

userId - local server userid

serviceOperationName - service operation - usually the top level rest call

Returns:

SubjectAreaNodeClients subject area nodes API objects

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - unknown server/service

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - User not authorized to call this service

org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException - internal error