Package org.odpi.openmetadata.accessservices.itinfrastructure.client

Class HostManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase

org.odpi.openmetadata.accessservices.itinfrastructure.client.HostManagerClient

All Implemented Interfaces:

DeploymentManagementInterface, HostManagerInterface, ServerPurposeManagerInterface

public class HostManagerClient
extends ITInfrastructureClientBase
implements HostManagerInterface

HostManagerClient supports the APIs to maintain hosts and their related objects.

Constructor Summary

Constructors

Constructor	Description
HostManagerClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
HostManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
HostManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
HostManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.
HostManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearClusterMember(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String hostGUID, String clusterMemberGUID, Date effectiveTime)	Remove a relationship between a host and an cluster member host.
String	createHost(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, HostProperties hostProperties)	Create a new metadata element to represent a host.
String	createHostFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a host using an existing metadata element as a template.
List<HostElement>	findHosts(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of host metadata elements that contain the search string.
List<HostElement>	getClusterMembersForHost(String userId, String hostGUID, Date effectiveTime, int startFrom, int pageSize)	Return the list of cluster members associated with a host.
HostElement	getHostByGUID(String userId, String guid)	Retrieve the host metadata element with the supplied unique identifier.
List<HostElement>	getHostsByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of host metadata elements with a matching qualified or display name.
List<HostElement>	getHostsForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize)	Retrieve the list of hosts created by this caller.
void	publishHost(String userId, String hostGUID)	Update the zones for the host asset so that it becomes visible to consumers.
void	removeHost(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String hostGUID)	Remove the metadata element representing a host.
void	setupClusterMember(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String hostGUID, String clusterMemberGUID, Date effectiveFrom, Date effectiveTo)	Create a relationship between a host and an cluster member host.
void	updateHost(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String hostGUID, boolean isMergeUpdate, HostProperties hostProperties)	Update the metadata element representing a host.
void	withdrawHost(String userId, String hostGUID)	Update the zones for the host asset so that it is no longer visible to consumers.

Methods inherited from class org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase

addServerPurpose, clearDeployment, clearServerPurpose, deployITAsset, getDeployedITAssets, getDeploymentDestinations, updateITAssetDeployment, updateServerPurpose

Methods inherited from class java.lang.Object

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

Constructor Details

HostManagerClient

public HostManagerClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                  throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

HostManagerClient

public HostManagerClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                  throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

HostManagerClient

public HostManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

HostManagerClient

public HostManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog,
 int maxPageSize)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

HostManagerClient

public HostManagerClient(String serverName,
 String serverPlatformURLRoot,
 ITInfrastructureRESTClient restClient,
 int maxPageSize)
                  throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

createHost

public String createHost(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 HostProperties hostProperties)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a host.

Specified by:

createHost in interface HostManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

infrastructureManagerIsHome - should the host be marked as owned by the infrastructure manager so others can not update?

hostProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createHostFromTemplate

public String createHostFromTemplate(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a host using an existing metadata element as a template.

Specified by:

createHostFromTemplate in interface HostManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

infrastructureManagerIsHome - should the host be marked as owned by the infrastructure manager so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateHost

public void updateHost(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String hostGUID,
 boolean isMergeUpdate,
 HostProperties hostProperties)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a host.

Specified by:

updateHost in interface HostManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

hostGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

hostProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupClusterMember

public void setupClusterMember(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String hostGUID,
 String clusterMemberGUID,
 Date effectiveFrom,
 Date effectiveTo)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a relationship between a host and an cluster member host.

Specified by:

setupClusterMember in interface HostManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset

hostGUID - unique identifier of the host

clusterMemberGUID - unique identifier of the cluster member host

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearClusterMember

public void clearClusterMember(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String hostGUID,
 String clusterMemberGUID,
 Date effectiveTime)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a relationship between a host and an cluster member host.

Specified by:

clearClusterMember in interface HostManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

hostGUID - unique identifier of the host

clusterMemberGUID - unique identifier of the cluster member host

effectiveTime - time when the hosting is effective

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishHost

public void publishHost(String userId,
 String hostGUID)
                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the host asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).

Specified by:

publishHost in interface HostManagerInterface

Parameters:

userId - calling user

hostGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawHost

public void withdrawHost(String userId,
 String hostGUID)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the host asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the host is first created).

Specified by:

withdrawHost in interface HostManagerInterface

Parameters:

userId - calling user

hostGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeHost

public void removeHost(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String hostGUID)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a host.

Specified by:

removeHost in interface HostManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

hostGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findHosts

public List<HostElement> findHosts(String userId,
 String searchString,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of host metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findHosts in interface HostManagerInterface

Parameters:

userId - calling user

searchString - string to find in the properties

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getHostsByName

public List<HostElement> getHostsByName(String userId,
 String name,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of host metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getHostsByName in interface HostManagerInterface

Parameters:

userId - calling user

name - name to search for

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getHostsForInfrastructureManager

public List<HostElement> getHostsForInfrastructureManager(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of hosts created by this caller.

Specified by:

getHostsForInfrastructureManager in interface HostManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager

infrastructureManagerName - unique name of software server capability representing the infrastructure manager

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getClusterMembersForHost

public List<HostElement> getClusterMembersForHost(String userId,
 String hostGUID,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of cluster members associated with a host.

Specified by:

getClusterMembersForHost in interface HostManagerInterface

Parameters:

userId - calling user

hostGUID - unique identifier of the host to query

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getHostByGUID

public HostElement getHostByGUID(String userId,
 String guid)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the host metadata element with the supplied unique identifier.

Specified by:

getHostByGUID in interface HostManagerInterface

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)