cz.cesnet.cloud.occi.api.http

Class HTTPClient

java.lang.Object

cz.cesnet.cloud.occi.api.Client

cz.cesnet.cloud.occi.api.http.HTTPClient

public class HTTPClient
extends Client

Class representing HTTP OCCI client.

Author:

Michal Kimle

Field Summary

Fields inherited from class cz.cesnet.cloud.occi.api.Client

MODEL_URI

Constructor Summary

Constructors

Constructor and Description
HTTPClient(URI endpoint) Constructor.
HTTPClient(URI endpoint, Authentication authentication) Constructor.
HTTPClient(URI endpoint, Authentication authentication, String mediaType, boolean autoconnect) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Establishes a connection.
URI	create(cz.cesnet.cloud.occi.core.Entity entity) Creates a new resource on the server.
boolean	delete(String resourceType) Deletes all resource of a certain resource type from the server.
boolean	delete(URI resourceIdentifier) Deletes all resource of a certain resource type or specific resource from the server.
List<cz.cesnet.cloud.occi.core.Entity>	describe() Retrieves descriptions for all available resources.
List<cz.cesnet.cloud.occi.core.Entity>	describe(String resourceType) Retrieves descriptions for available resources of a certain type.
List<cz.cesnet.cloud.occi.core.Entity>	describe(URI resourceIdentifier) Retrieves descriptions for available resources specified by a type identifier or resource identifier.
String	getMediaType() Returns media type of the connection.
List<URI>	list() Retrieves all available resources represented by resource locations (URIs).
List<URI>	list(String resourceType) Retrieves available resources of a certain type represented by resource locations (URIs).
List<URI>	list(URI resourceIdentifier) Retrieves available resources of a certain type represented by resource locations (URIs).
void	refresh() Refreshes the Model used inside the client.
void	setMediaType(String mediaType) Sets media type for the connection.
boolean	trigger(String resourceType, cz.cesnet.cloud.occi.core.ActionInstance action) Triggers given action on a specified set of resources.
boolean	trigger(URI resourceIdentifier, cz.cesnet.cloud.occi.core.ActionInstance action) Triggers given action on a set of resources or on a specified resource.

Methods inherited from class cz.cesnet.cloud.occi.api.Client

getAuthentication, getEndpoint, getModel, isConnected, setAuthentication, setConnected, setEndpoint, setModel

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPClient

public HTTPClient(URI endpoint,
          Authentication authentication,
          String mediaType,
          boolean autoconnect)
           throws CommunicationException

Constructor.

HTTPClient has three constructors via which one can set remote server's endpoint, authentication method, media type for HTTP messages and whether client should automatically connect to the server or not.

By default text/plain is used as media type and client is initialized without authentication method. Client automatically connects to the remote server by default when authentication method is set.

Examples:

Client client = new HTTPClient(URI.create("https://remote.server.net")); client.connect();

Client client = new HTTPClient(URI.create("https://remote.server.net"), new BasicAuthentication("username", "password"), MediaType.TEXT_OCCI, true);

Parameters:

endpoint - cannot be null

authentication - authentication method which will be used to authenticate client against the server

mediaType - string representing HTTP media type used in communication

autoconnect -

Throws:

CommunicationException

HTTPClient

public HTTPClient(URI endpoint,
          Authentication authentication)
           throws CommunicationException

Constructor.

Parameters:

endpoint - cannot be null

authentication -

Throws:

CommunicationException

HTTPClient

public HTTPClient(URI endpoint)
           throws CommunicationException

Constructor.

Parameters:

endpoint - cannot be null

Throws:

CommunicationException

Method Detail

setMediaType

public void setMediaType(String mediaType)

Sets media type for the connection.

Parameters:

mediaType - media type

getMediaType

public String getMediaType()

Returns media type of the connection.

Returns:

media type

connect

public void connect()
             throws CommunicationException

Description copied from class: Client

Establishes a connection.

Specified by:

connect in class Client

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.connect()

list

public List<URI> list()
               throws CommunicationException

Description copied from class: Client

Retrieves all available resources represented by resource locations (URIs).

Example:

List<URI> list = client.list();

Specified by:

list in class Client

Returns:

resources represented by resource locations (URIs)

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.list()

list

public List<URI> list(String resourceType)
               throws CommunicationException

Description copied from class: Client

Retrieves available resources of a certain type represented by resource locations (URIs).

Example:

List<URI> list = client.list("compute");

Specified by:

list in class Client

Parameters:

resourceType - resource type in shortened format (e.g. "compute", "storage", "network")

Returns:

resources represented by resource locations (URIs)

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.list(java.lang.String)

list

public List<URI> list(URI resourceIdentifier)
               throws CommunicationException

Description copied from class: Client

Retrieves available resources of a certain type represented by resource locations (URIs).

Example:

List<URI> list = client.list(URI.create("http://schemas.ogf.org/occi/infrastructure#network"));

Specified by:

list in class Client

Parameters:

resourceIdentifier - full resource type identifier

Returns:

resources represented by resource locations (URIs)

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.list(java.net.URI)

describe

public List<cz.cesnet.cloud.occi.core.Entity> describe()
                                                throws CommunicationException

Description copied from class: Client

Retrieves descriptions for all available resources.

Example:

List<Entity> list = client.describe();

Specified by:

describe in class Client

Returns:

list of resource or link descriptions

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.describe()

describe

public List<cz.cesnet.cloud.occi.core.Entity> describe(String resourceType)
                                                throws CommunicationException

Description copied from class: Client

Retrieves descriptions for available resources of a certain type.

Example:

List<Entity> list = client.describe("compute");

Specified by:

describe in class Client

Parameters:

resourceType - resource type in shortened format (e.g. "compute", "storage", "network")

Returns:

list of resource or link descriptions

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.describe(java.lang.String)

describe

public List<cz.cesnet.cloud.occi.core.Entity> describe(URI resourceIdentifier)
                                                throws CommunicationException

Description copied from class: Client

Retrieves descriptions for available resources specified by a type identifier or resource identifier.

Example:

List<Entity> list = client.describe(URI.create("http://schemas.ogf.org/occi/infrastructure#network"));
...
list = client.describe(URI.create("https://remote.server.net/storage/123"));

Specified by:

describe in class Client

Parameters:

resourceIdentifier - either full resource type identifier or full resource identifier

Returns:

list of resource or link descriptions

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.describe(java.net.URI)

create

public URI create(cz.cesnet.cloud.occi.core.Entity entity)
           throws CommunicationException

Description copied from class: Client

Creates a new resource on the server.

Example:

Model model = client.getModel();
EntityBuilder entityBuilder = new EntityBuilder(model);
Compute compute = entityBuilder.getCompute();
compute.addMixin(model.findMixin("debian7", "os_tpl"));
compute.addMixin(model.findMixin("small", "resource_tpl"));
compute.setMemory(1024);
compute.setCores(4);
URI location = client.create(compute);

Specified by:

create in class Client

Parameters:

entity - Creates a new resource on the server.

Returns:

URI of the new resource

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.create(cz.cesnet.cloud.occi.core.Entity)

delete

public boolean delete(String resourceType)
               throws CommunicationException

Description copied from class: Client

Deletes all resource of a certain resource type from the server.

Example:

boolean wasSuccessful = client.delete("compute");

Specified by:

delete in class Client

Parameters:

resourceType - resource type in shortened format (e.g. "compute", "storage", "network")

Returns:

true if the deletion was successful, false otherwise

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.delete(java.lang.String)

delete

public boolean delete(URI resourceIdentifier)
               throws CommunicationException

Description copied from class: Client

Deletes all resource of a certain resource type or specific resource from the server.

Example:

boolean wasSuccessful = client.delete(URI.create("http://schemas.ogf.org/occi/infrastructure#network"));
...
wasSuccessful = client.delete(URI.create("https://remote.server.net/storage/123"));

Specified by:

delete in class Client

Parameters:

resourceIdentifier - either full resource type identifier or full resource identifier

Returns:

true if the deletion was successful, false otherwise

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.delete(java.net.URI)

trigger

public boolean trigger(String resourceType,
              cz.cesnet.cloud.occi.core.ActionInstance action)
                throws CommunicationException

Description copied from class: Client

Triggers given action on a specified set of resources.

Example:

Model model = client.getModel();
EntityBuilder entityBuilder = new EntityBuilder(model);
ActionInstance actionInstance = entityBuilder.getActionInstance("start");
boolean wasSuccessful = client.trigger("compute", actionInstance);

Specified by:

trigger in class Client

Parameters:

resourceType - resource type in shortened format (e.g. "compute", "storage", "network")

action - type of action

Returns:

true if the action was successful, false otherwise

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.trigger(java.lang.String, cz.cesnet.cloud.occi.core.ActionInstance)

trigger

public boolean trigger(URI resourceIdentifier,
              cz.cesnet.cloud.occi.core.ActionInstance action)
                throws CommunicationException

Description copied from class: Client

Triggers given action on a set of resources or on a specified resource.

Example:

Model model = client.getModel();
EntityBuilder entityBuilder = new EntityBuilder(model);
ActionInstance actionInstance = entityBuilder.getActionInstance("start");
boolean wasSuccessful = client.trigger(URI.create("http://schemas.ogf.org/occi/infrastructure#network"), actionInstance);
...
wasSuccessful = client.trigger(URI.create("https://remote.server.net/compute/456"), actionInstance);

Specified by:

trigger in class Client

Parameters:

resourceIdentifier - either full resource type identifier or full resource identifier

action - type of action

Returns:

true if the action was successful, false otherwise

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.trigger(java.net.URI, cz.cesnet.cloud.occi.core.ActionInstance)

refresh

public void refresh()
             throws CommunicationException

Description copied from class: Client

Refreshes the Model used inside the client. Useful for updating the model without creating a new instance or reconnecting. Saves a lot of time in an interactive mode.

Specified by:

refresh in class Client

Throws:

CommunicationException - when error occured during the communication with server

See Also:

Client.refresh()