com.cloudbees.api.cr

Class CloudResource

java.lang.Object

com.cloudbees.api.cr.CloudResource

public class CloudResource
extends Object

Client-side representation of a remote cloud resource.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE MIME content type of the cloud resource.
static String	CONTENT_TYPE_UTF8
static PrintStream	DEBUG If set to non-null, the request and the response details are sent to this stream
static org.codehaus.jackson.map.ObjectMapper	MAPPER
static Capability	READ_CAPABILITY Capability required to retrieve the state of CloudResource.

Constructor Summary

Constructors

Constructor and Description
CloudResource(URL url, Credential credential)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends CloudResourceFacet> T	as(Class<T> facet) Creates a client-side wrapper to access this cloud resource through the specified cloud resource type.
<T extends CloudResourceFacet> T	coerce(Class<T> facet) Creates a client-side wrapper to access this cloud resource through the specified cloud resource type.
HttpURLConnection	connect()
CloudResource	create(String path, Object request) Makes a POST request with the specified request payload, then expect 201 status that reports the location of the newly created resource.
boolean	equals(Object o)
static CloudResource	fromOAuthToken(URL url, OauthToken token)
static CloudResource	fromOAuthToken(URL url, String oauthAccessToken) A cloud resource is identified by its URL, and to talk to it we need an OAuth access token
Credential	getCredential()
URL	getUrl() URL of this cloud resource.
int	hashCode()
<T extends CloudResourceFacet> boolean	hasType(Class<T> facet) Does this cloud resource implement the specified type?
boolean	hasType(String fullyQualifiedTypeName) Does this cloud resource implement the specified type?
<T> T	post(String path, Object request, Class<T> responseType) Makes a POST request with the specified request payload, then return the data-bound JSON object in the specified 'response' type.
org.codehaus.jackson.node.ObjectNode	retrieve()
org.codehaus.jackson.node.ObjectNode	retrieve(boolean force) Retrieves the current state of the CloudResource object as JSON DOM node.
<T> T	retrieve(Class<T> type)
<T> T	retrieve(Class<T> type, boolean force) Retrieves the current state of the cloud resource and data-bind it to the given object via Jackson
void	setTypes(Collection<String> types) Under some limited circumstances, you get a list of types of another cloud resource when you get a reference to it.
String	toString()
static Set<String>	typesOf(Class<?> bean) Recursively list up all the CloudResourceType annotations on the given class and return them.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAPPER

public static final org.codehaus.jackson.map.ObjectMapper MAPPER

CONTENT_TYPE

public static final String CONTENT_TYPE

MIME content type of the cloud resource.

See Also:

Constant Field Values

CONTENT_TYPE_UTF8

public static final String CONTENT_TYPE_UTF8

See Also:

Constant Field Values

READ_CAPABILITY

public static Capability READ_CAPABILITY

Capability required to retrieve the state of CloudResource.

DEBUG

public static PrintStream DEBUG

If set to non-null, the request and the response details are sent to this stream

Constructor Detail

CloudResource

public CloudResource(URL url,
             Credential credential)

Method Detail

fromOAuthToken

public static CloudResource fromOAuthToken(URL url,
                           String oauthAccessToken)

A cloud resource is identified by its URL, and to talk to it we need an OAuth access token

fromOAuthToken

public static CloudResource fromOAuthToken(URL url,
                           OauthToken token)

getUrl

public URL getUrl()

URL of this cloud resource.

getCredential

public Credential getCredential()

as

public <T extends CloudResourceFacet> T as(Class<T> facet)
                                throws IOException

Creates a client-side wrapper to access this cloud resource through the specified cloud resource type.

Throws:

IOException

coerce

public <T extends CloudResourceFacet> T coerce(Class<T> facet)
                                    throws IOException

Creates a client-side wrapper to access this cloud resource through the specified cloud resource type. Unlike as(Class), this version does not check if the cloud resource actually advertises the specified cloud resource type.

Throws:

IOException

hasType

public <T extends CloudResourceFacet> boolean hasType(Class<T> facet)
                throws IOException

Does this cloud resource implement the specified type?

Throws:

IOException

hasType

public boolean hasType(String fullyQualifiedTypeName)
                throws IOException

Does this cloud resource implement the specified type?

Throws:

IOException

setTypes

public void setTypes(Collection<String> types)

Under some limited circumstances, you get a list of types of another cloud resource when you get a reference to it. In such a case, use this method to inform CloudResource about its types. This will save an unnecessary roundtrip.

retrieve

public org.codehaus.jackson.node.ObjectNode retrieve(boolean force)
                                              throws IOException

Retrieves the current state of the CloudResource object as JSON DOM node.

Parameters:

force - if false, cached value is used if available.

Throws:

IOException

retrieve

public org.codehaus.jackson.node.ObjectNode retrieve()
                                              throws IOException

Throws:

IOException

retrieve

public <T> T retrieve(Class<T> type,
             boolean force)
           throws IOException

Retrieves the current state of the cloud resource and data-bind it to the given object via Jackson

Throws:

IOException

retrieve

public <T> T retrieve(Class<T> type)
           throws IOException

Throws:

IOException

post

public <T> T post(String path,
         Object request,
         Class<T> responseType)
       throws IOException

Makes a POST request with the specified request payload, then return the data-bound JSON object in the specified 'response' type.

Parameters:

path - Normally relative URL (from the URL of the cloud resource) that indicates the endpoint to POST to.

Throws:

IOException

create

public CloudResource create(String path,
                   Object request)
                     throws IOException

Makes a POST request with the specified request payload, then expect 201 status that reports the location of the newly created resource.

Parameters:

path - Normally relative URL (from the URL of the cloud resource) that indicates the endpoint to POST to.

Throws:

IOException

connect

public HttpURLConnection connect()
                          throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

typesOf

public static Set<String> typesOf(Class<?> bean)

Recursively list up all the CloudResourceType annotations on the given class and return them.