Package org.odpi.openmetadata.accessservices.itinfrastructure.server

Class ITInfrastructureRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.itinfrastructure.server.ITInfrastructureRESTServices

public class ITInfrastructureRESTServices
extends Object

The ITInfrastructureRESTServices provides the server-side implementation of the IT Infrastructure Open Metadata Assess Service (OMAS). This interface provides support for defining infrastructure assets and their supporting elements.

Constructor Summary

Constructors

Constructor	Description
ITInfrastructureRESTServices()	Default constructor

Method Summary

Modifier and Type	Method	Description
GUIDResponse	createEndpoint(String serverName, String userId, String infrastructureGUID, EndpointRequestBody requestBody)	Create a new metadata element to represent a endpoint.
GUIDResponse	createEndpointFromTemplate(String serverName, String userId, String infrastructureGUID, String networkAddress, String templateGUID, TemplateRequestBody requestBody)	Create a new metadata element to represent a endpoint using an existing metadata element as a template.
EndpointsResponse	findEndpoints(String serverName, String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of endpoint metadata elements that contain the search string.
EndpointResponse	getEndpointByGUID(String serverName, String userId, String guid)	Retrieve the endpoint metadata element with the supplied unique identifier.
EndpointsResponse	getEndpointsByName(String serverName, String userId, String name, int startFrom, int pageSize)	Retrieve the list of endpoint metadata elements with a matching qualified or display name.
VoidResponse	removeEndpoint(String serverName, String userId, String endpointGUID, MetadataSourceRequestBody requestBody)	Remove the metadata element representing a endpoint.
VoidResponse	updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, EndpointRequestBody requestBody)	Update the metadata element representing a endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

ITInfrastructureRESTServices

public ITInfrastructureRESTServices()

Default constructor

Method Detail

createEndpoint

public GUIDResponse createEndpoint(String serverName,
                                   String userId,
                                   String infrastructureGUID,
                                   EndpointRequestBody requestBody)

Create a new metadata element to represent a endpoint.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

infrastructureGUID - unique identifier of the infrastructure to connect it to (optional)

requestBody - properties about the endpoint

Returns:

unique identifier of the new endpoint or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

createEndpointFromTemplate

public GUIDResponse createEndpointFromTemplate(String serverName,
                                               String userId,
                                               String infrastructureGUID,
                                               String networkAddress,
                                               String templateGUID,
                                               TemplateRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to.

userId - calling user

infrastructureGUID - unique identifier of the infrastructure to connect it to (optional)

networkAddress - location of the endpoint

templateGUID - unique identifier of the metadata element to copy

requestBody - properties that override the template

Returns:

unique identifier of the new endpoint or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

updateEndpoint

public VoidResponse updateEndpoint(String serverName,
                                   String userId,
                                   String endpointGUID,
                                   boolean isMergeUpdate,
                                   EndpointRequestBody requestBody)

Update the metadata element representing a endpoint.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

endpointGUID - unique identifier of the metadata element to update

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

requestBody - new properties for the metadata element

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

removeEndpoint

public VoidResponse removeEndpoint(String serverName,
                                   String userId,
                                   String endpointGUID,
                                   MetadataSourceRequestBody requestBody)

Remove the metadata element representing a endpoint.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

endpointGUID - unique identifier of the metadata element to remove

requestBody - external source identifiers

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

findEndpoints

public EndpointsResponse findEndpoints(String serverName,
                                       String userId,
                                       String searchString,
                                       int startFrom,
                                       int pageSize)

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

Parameters:

serverName - name of the service to route the request to.

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getEndpointsByName

public EndpointsResponse getEndpointsByName(String serverName,
                                            String userId,
                                            String name,
                                            int startFrom,
                                            int pageSize)

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

Parameters:

serverName - name of the service to route the request to.

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getEndpointByGUID

public EndpointResponse getEndpointByGUID(String serverName,
                                          String userId,
                                          String guid)

Retrieve the endpoint metadata element with the supplied unique identifier.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

requested metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)