org.odpi.openmetadata.userinterfaces.adminservices

Interface UIServerAdministration

public interface UIServerAdministration

UIServerAdministration defines the administrative interface for an User Interface (UI) Server. It is used to create both the Java client and the RESTful server-side implementation. It provides all of the configuration properties for User Interface configuration .

There are four types of operations supported by UIServerAdministration:

• Basic configuration - these methods use the minimum of configuration information to run the server using default properties.
• Advanced Configuration - provides access to all configuration properties to provide fine-grained control of the server.
• Initialization and shutdown - these methods control the initialization and shutdown of the open metadata and governance services based on the supplied configuration.
• Operational status and control - these methods query the status of the open metadata and governance services as well as the audit log.

Method Summary

Modifier and Type	Method and Description
void	activateWithStoredConfig(String userId, String serverName) Activate the open metadata and governance services using the stored configuration information.
void	activateWithSuppliedConfig(String userId, String serverName, UIServerConfig configuration) Activate the open metadata and governance services using the supplied configuration document.
void	deactivatePermanently(String userId, String serverName) Permanently deactivate any open metadata and governance services and unregister from any cohorts.
void	deactivateTemporarily(String userId, String serverName) Temporarily deactivate any open metadata and governance services.
UIServerConfig	getCurrentConfiguration(String userId, String serverName) Return the complete set of configuration properties in use by the server.
String	getServerOrigin() Return the origin of this server implementation.
void	setMaxPageSize(String userId, String serverName, int maxPageSize) Set an upper limit in the page size that can be requested on a REST call to the server.
void	setOrganizationName(String userId, String serverName, String organizationName) Set up the name of the organization that is running this server.
void	setServerType(String userId, String serverName, String serverType) Set up the descriptive type of the server.
void	setServerURLRoot(String userId, String serverName, String serverURLRoot) Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces.
void	setServerUserId(String userId, String serverName, String id) Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Method Detail

getServerOrigin

String getServerOrigin()

Return the origin of this server implementation.

Returns:

OMAG Server Origin

setServerURLRoot

void setServerURLRoot(String userId,
                      String serverName,
                      String serverURLRoot)
               throws OMAGNotAuthorizedException,
                      InvalidParameterException

Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces. The default value is "localhost:8080".

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serverURLRoot - String url.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - invalid serverName or serverURLRoot parameter.

setServerType

void setServerType(String userId,
                   String serverName,
                   String serverType)
            throws OMAGNotAuthorizedException,
                   InvalidParameterException

Set up the descriptive type of the server. This value is added to distributed events to make it easier to understand the source of events. The default value is "Open Metadata and Governance Server".

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serverType - short description for the type of server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - invalid serverName or serverType parameter.

setOrganizationName

void setOrganizationName(String userId,
                         String serverName,
                         String organizationName)
                  throws OMAGNotAuthorizedException,
                         InvalidParameterException

Set up the name of the organization that is running this server. This value is added to distributed events to make it easier to understand the source of events. The default value is null.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

organizationName - String name of the organization.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - invalid serverName or organizationName parameter.

setServerUserId

void setServerUserId(String userId,
                     String serverName,
                     String id)
              throws OMAGNotAuthorizedException,
                     InvalidParameterException

Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Parameters:

userId - user that is issuing the request.

serverName - local server name.

id - String user is for the server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

InvalidParameterException - invalid serverName or serverURLRoot parameter.

setMaxPageSize

void setMaxPageSize(String userId,
                    String serverName,
                    int maxPageSize)
             throws OMAGNotAuthorizedException,
                    InvalidParameterException

Set an upper limit in the page size that can be requested on a REST call to the server. The default value is 1000.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

maxPageSize - max number of elements that can be returned on a request.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - invalid serverName or organizationName parameter.

getCurrentConfiguration

UIServerConfig getCurrentConfiguration(String userId,
                                       String serverName)
                                throws OMAGNotAuthorizedException,
                                       InvalidParameterException

Return the complete set of configuration properties in use by the server.

Parameters:

userId - - user that is issuing the request

serverName - - local server name

Returns:

UIServerConfig properties or

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - invalid serverName parameter.

activateWithStoredConfig

void activateWithStoredConfig(String userId,
                              String serverName)
                       throws OMAGNotAuthorizedException,
                              InvalidParameterException,
                              OMAGConfigurationErrorException

Activate the open metadata and governance services using the stored configuration information.

Parameters:

userId - - user that is issuing the request

serverName - - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - the server name is invalid or

OMAGConfigurationErrorException - there is a problem using the supplied configuration.

activateWithSuppliedConfig

void activateWithSuppliedConfig(String userId,
                                String serverName,
                                UIServerConfig configuration)
                         throws OMAGNotAuthorizedException,
                                InvalidParameterException,
                                OMAGConfigurationErrorException

Activate the open metadata and governance services using the supplied configuration document.

Parameters:

userId - - user that is issuing the request

configuration - - properties used to initialize the services

serverName - - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - the server name is invalid or

OMAGConfigurationErrorException - there is a problem using the supplied configuration.

deactivateTemporarily

void deactivateTemporarily(String userId,
                           String serverName)
                    throws OMAGNotAuthorizedException,
                           InvalidParameterException

Temporarily deactivate any open metadata and governance services.

Parameters:

userId - user that is issuing the request

serverName - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - the serverName is invalid.

deactivatePermanently

void deactivatePermanently(String userId,
                           String serverName)
                    throws OMAGNotAuthorizedException,
                           InvalidParameterException

Permanently deactivate any open metadata and governance services and unregister from any cohorts.

Parameters:

userId - user that is issuing the request

serverName - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

InvalidParameterException - the serverName is invalid.