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

Class ITInfrastructureResource

java.lang.Object

org.odpi.openmetadata.accessservices.itinfrastructure.server.spring.ITInfrastructureResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/it-infrastructure/users/{userId}")
public class ITInfrastructureResource
extends Object

The ITInfrastructureResource provides the server-side implementation of the IT Infrastructure Open Metadata Assess Service (OMAS).

Constructor Summary

Constructors

Constructor	Description
ITInfrastructureResource()	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	createEndpoint(String serverName, String userId, 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.
GUIDResponse	createEndpointFromTemplate(String serverName, String userId, 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

ITInfrastructureResource

public ITInfrastructureResource()

Default constructor

Method Detail

createEndpoint

@PostMapping(path="/endpoints")
public GUIDResponse createEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @RequestBody
                                   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

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)

createEndpoint

@PostMapping(path="/endpoints/for-infrastructure/{infrastructureGUID}")
public GUIDResponse createEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String infrastructureGUID,
                                   @RequestBody
                                   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

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

@PostMapping(path="/endpoints/network-address/{networkAddress}/from-template/{templateGUID}")
public GUIDResponse createEndpointFromTemplate(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String networkAddress,
                                               @PathVariable
                                               String templateGUID,
                                               @RequestBody
                                               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

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)

createEndpointFromTemplate

@PostMapping(path="/endpoints/for-infrastructure/{infrastructureGUID}/network-address/{networkAddress}/from-template/{templateGUID}")
public GUIDResponse createEndpointFromTemplate(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String infrastructureGUID,
                                               @PathVariable
                                               String networkAddress,
                                               @PathVariable
                                               String templateGUID,
                                               @RequestBody
                                               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

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

@PostMapping(path="/endpoints/{endpointGUID}")
public VoidResponse updateEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String endpointGUID,
                                   @RequestParam
                                   boolean isMergeUpdate,
                                   @RequestBody
                                   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

@PostMapping(path="/endpoints/{endpointGUID}/delete")
public VoidResponse removeEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String endpointGUID,
                                   @RequestBody
                                   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

@GetMapping(path="/endpoints/by-search-string/{searchString}")
public EndpointsResponse findEndpoints(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String searchString,
                                       @RequestParam
                                       int startFrom,
                                       @RequestParam
                                       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

@GetMapping(path="/endpoints/by-name/{name}")
public EndpointsResponse getEndpointsByName(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String name,
                                            @RequestParam
                                            int startFrom,
                                            @RequestParam
                                            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

@GetMapping(path="/endpoints/{guid}")
public EndpointResponse getEndpointByGUID(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          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)