com.emc.vipr.client.catalog

Class Catalog

java.lang.Object

com.emc.vipr.client.catalog.Catalog

public class Catalog
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Catalog(ViPRCatalogClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
CategoryInfo	browse() Browse the root of the service catalog.
CategoryInfo	browseCategory(java.lang.String path) Browse the service catalog by path to a cateogy (Path separated with slashes).
ServiceInfo	browseService(java.lang.String path) Browse the service catalog by path to a service (Path separated with slashes).
java.util.List<Reference>	getAssetDependencies(java.lang.String asset, java.lang.String service) Retrieves asset option dependencies for the defined asset.
java.util.List<Option>	getAssetOptions(java.lang.String asset) Retrieves asset options for the defined asset with no parameters.
java.util.List<Option>	getAssetOptions(java.lang.String asset, java.util.Map<java.lang.String,java.lang.Object> parameters) Retrieves asset options for the defined asset.
CategoryInfo	getCategory(java.lang.String id) Retrieves a category by identifier.
ServiceInfo	getService(java.lang.String id) Retrieves a service by identifier.
java.lang.String	getServiceDescriptor(java.lang.String id) Retrieves a service descriptor for the identifier.
OrderInfo	order(java.lang.String serviceId, java.util.Map<java.lang.String,java.lang.Object> parameters) Places an order for the service with the given service identifier.
OrderInfo	order(java.lang.String serviceId, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters) Places an order for the service with the given service identifier.
OrderInfo	orderByPath(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> parameters) Places an order for the service with the given service path.
OrderInfo	orderByPath(java.lang.String path, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters) Places an order for the service with the given service identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

Catalog

public Catalog(ViPRCatalogClient parent,
               RestClient client)

Method Detail

getAssetOptions

public java.util.List<Option> getAssetOptions(java.lang.String asset)

Retrieves asset options for the defined asset with no parameters.

API Call: GET /api/options/{asset}

Parameters:

asset - Name of the asset to retrieve options for.

Returns:

Options for this asset type.

getAssetOptions

public java.util.List<Option> getAssetOptions(java.lang.String asset,
                                              java.util.Map<java.lang.String,java.lang.Object> parameters)

Retrieves asset options for the defined asset.

API Call: GET /api/options/{asset}

Parameters:

asset - Name of the asset to retrieve options for.

parameters - Parameters used to match for asset dependencies.

Returns:

Options for this asset type.

getAssetDependencies

public java.util.List<Reference> getAssetDependencies(java.lang.String asset,
                                                      java.lang.String service)

Retrieves asset option dependencies for the defined asset.

API Call: GET /api/options/{asset}/dependencies?service={service}

Parameters:

asset - Name of the asset to retrieve dependencies for.

service - The serviceId of the service descriptor or ID of the catalog service. The service is used to compute dependencies for a particular service form.

Returns:

Dependencies for this asset type.

getCategory

public CategoryInfo getCategory(java.lang.String id)

Retrieves a category by identifier.

API Call: GET /api/categories/{id}

Parameters:

id - Category identifier.

Returns:

Category information.

getService

public ServiceInfo getService(java.lang.String id)

Retrieves a service by identifier.

API Call: GET /api/services/{id}

Parameters:

id - Service identifier.

Returns:

Service information.

getServiceDescriptor

public java.lang.String getServiceDescriptor(java.lang.String id)

Retrieves a service descriptor for the identifier.

API Call: GET /api/services/{id}/descriptor

Parameters:

id - Service identifier.

Returns:

Service Descriptor information for this service (as JSON)

browse

public CategoryInfo browse()

Browse the root of the service catalog.

API Call: GET /api/catalog

Returns:

Category information.

browseCategory

public CategoryInfo browseCategory(java.lang.String path)

Browse the service catalog by path to a cateogy (Path separated with slashes).

API Call: GET /api/catalog/{ ... path ...}

Parameters:

path - Slash separate path to the category.

Returns:

Category information.

browseService

public ServiceInfo browseService(java.lang.String path)

Browse the service catalog by path to a service (Path separated with slashes).

API Call: GET /api/catalog/{ ... path ...}

Parameters:

path - Slash separate path to the service.

Returns:

Service information.

order

public OrderInfo order(java.lang.String serviceId,
                       java.util.Map<java.lang.String,java.lang.Object> parameters)
                throws ValidationException

Places an order for the service with the given service identifier.

API Call: POST /api/services/{serviceId}

Parameters:

serviceId - Service identifier.

parameters - Map containing key-value parameter pairs.

Returns:

Information on submitted order.

Throws:

ValidationException

order

public OrderInfo order(java.lang.String serviceId,
                       javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters)
                throws ValidationException

Places an order for the service with the given service identifier.

API Call: POST /api/services/{serviceId}

Parameters:

serviceId - Service identifier.

parameters - MultivaluedMap containing key-value parameter pairs.

Returns:

Information on submitted order.

Throws:

ValidationException

orderByPath

public OrderInfo orderByPath(java.lang.String path,
                             java.util.Map<java.lang.String,java.lang.Object> parameters)
                      throws ValidationException

Places an order for the service with the given service path.

API Call: POST /api/catalog/{ ... path ...}

Parameters:

path - Slash separate path to the category.

parameters - Map containing key-value parameter pairs.

Returns:

Information on submitted order.

Throws:

ValidationException

orderByPath

public OrderInfo orderByPath(java.lang.String path,
                             javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters)
                      throws ValidationException

Places an order for the service with the given service identifier.

API Call: POST /api/catalog/{ ... path ...}

Parameters:

path - Slash separate path to the category.

parameters - MultivaluedMap containing key-value parameter pairs.

Returns:

Information on submitted order.

Throws:

ValidationException