Package com.janeirodigital.shapetrees.core.resources

Class ManageableInstance

java.lang.Object

com.janeirodigital.shapetrees.core.resources.ManageableInstance

public class ManageableInstance
extends Object

A ManageableInstance represents a pairing of a shape tree ManagerResource and a ManageableResource. The ManageableInstance may represent a managed state, where the ManageableResource is a ManagedResource that is managed by one or more shape trees assigned by the ShapeTreeManager in the ManagedResource.Conversely, it could represent an unmanaged state, where the ManageableResource is an UnmanagedResource and the ManagedResource is a MissingManagedResource. Lastly, it may represent other state combinations where one or both of the ManageableResource or ManagedResource are missing. Both ManageableResource and ManagedResource are looked up and loaded upon construction of the ManageableInstance, which should be done through a ResourceAccessor. Once constructed, the ManageableInstance is immutable.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEXT_TURTLE

Method Summary

Modifier and Type	Method	Description
static URL	calculateManagedUrl(URL managerUrl, ResourceAttributes attributes)	Looks for the presence of the http://www.w3.org/ns/shapetrees#manages HTTP Link Relation in the provided attributes, with a valid target URL of a ManagedResource.
static ManageableInstance	createInstanceResource(ResourceAccessor accessor, ShapeTreeContext context, URL resourceUrl, ResourceAttributes headers, String body, String contentType)	Creates the resource identified by the provided resourceUrl and gets a corresponding ManageableInstance.
List<ManageableInstance>	getContainedInstances()	Gets a list of ManageableInstances contained in a managed resource that is a container.
static ManageableInstance	getInstance(ResourceAccessor accessor, ShapeTreeContext context, URL resourceUrl)	Return a ManageableInstance constructed starting with the resource identified by the provided resourceUrl.
ManageableResource	getManageableResource()
ManagerResource	getManagerResource()
ResourceAccessor	getResourceAccessor()
ShapeTreeContext	getShapeTreeContext()
boolean	isManaged()	Indicates whether the ManageableInstance represents a managed state, with a ManagedResource assigned one or more shape trees by a ShapeTreeManager in a ManagerResource
boolean	isUnmanaged()	Indicates whether the ManageableInstance represents an unmanaged state, with a UnmanagedResource and a MissingManagerResource
boolean	isWasRequestForManager()
static ManageableInstance	reloadInstance(ManageableInstance originalInstance)	Return a new version of provided ManageableInstance originalInstance
boolean	wasRequestForManager()	Indicates whether the HTTP request that triggered the initialization of the ManageableInstance was targeted towards the ManagerResource or the ManageableResource.

Methods inherited from class java.lang.Object

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

Field Details

TEXT_TURTLE

public static final String TEXT_TURTLE

See Also:

• Constant Field Values

Method Details

wasRequestForManager

public boolean wasRequestForManager()

Indicates whether the HTTP request that triggered the initialization of the ManageableInstance was targeted towards the ManagerResource or the ManageableResource.

Returns:

True when the request targeted the ManagerResource

isUnmanaged

public boolean isUnmanaged()

Indicates whether the ManageableInstance represents an unmanaged state, with a UnmanagedResource and a MissingManagerResource

Returns:

True when the instance is in an unmanaged state

isManaged

public boolean isManaged()

Indicates whether the ManageableInstance represents a managed state, with a ManagedResource assigned one or more shape trees by a ShapeTreeManager in a ManagerResource

Returns:

True when the instance is in an managed state

getContainedInstances

public List<ManageableInstance> getContainedInstances()
                                               throws ShapeTreeException

Gets a list of ManageableInstances contained in a managed resource that is a container.

Returns:

List of contained ManageableInstances

Throws:

ShapeTreeException

reloadInstance

public static ManageableInstance reloadInstance(ManageableInstance originalInstance)
                                         throws ShapeTreeException

Return a new version of provided ManageableInstance originalInstance

Parameters:

originalInstance - Original instance to get a new version of

Returns:

Reloaded version of originalInstance

Throws:

ShapeTreeException

getInstance

public static ManageableInstance getInstance(ResourceAccessor accessor,
 ShapeTreeContext context,
 URL resourceUrl)
                                      throws ShapeTreeException

Return a ManageableInstance constructed starting with the resource identified by the provided resourceUrl. The resourceUrl may target either a ManageableResource, or a ManagerResource.

Both the ManageableResource and ManagerResource are retrieved and loaded as specifically typed sub-classes that indicate whether they exist, or (in the case of ManageableResource) whether they are managed.

Parameters:

accessor - ResourceAccessor to use to get InstanceResources

context - ShapeTreeContext

resourceUrl - URL of the resource to get

Returns:

ManageableInstance including ManageableResource and ManagerResource

Throws:

ShapeTreeException

calculateManagedUrl

public static URL calculateManagedUrl(URL managerUrl,
 ResourceAttributes attributes)
                               throws ShapeTreeException

Looks for the presence of the http://www.w3.org/ns/shapetrees#manages HTTP Link Relation in the provided attributes, with a valid target URL of a ManagedResource. Falls back to a relatively crude inference when the more reliable header isn't available

Parameters:

managerUrl - URL of the ShapeTreeManager

attributes - Parsed link headers from ManagerResource response

Returns:

URL of ManagedResource

Throws:

ShapeTreeException

createInstanceResource

public static ManageableInstance createInstanceResource(ResourceAccessor accessor,
 ShapeTreeContext context,
 URL resourceUrl,
 ResourceAttributes headers,
 String body,
 String contentType)
                                                 throws ShapeTreeException

Creates the resource identified by the provided resourceUrl and gets a corresponding ManageableInstance. This may create either a ManageableResource or a ManagerResource. The newly created resource is loaded into the instance, and the corresponding ManageableResource or ManagerResource is looked up and loaded into the instance alongside it. They are loaded as specifically typed sub-classes that indicate whether they exist, or (in the case of ManageableResource), whether they are managed.

Parameters:

context - ShapeTreeContext

resourceUrl - URL of the resource to create

headers - Incoming HTTP headers

body - Body of the resource to create

contentType - Content-type of the resource to create

Returns:

ManageableInstance including ManageableResource and ManagerResource

Throws:

ShapeTreeException

getResourceAccessor

public ResourceAccessor getResourceAccessor()

getShapeTreeContext

public ShapeTreeContext getShapeTreeContext()

isWasRequestForManager

public boolean isWasRequestForManager()

getManageableResource

public ManageableResource getManageableResource()

getManagerResource

public ManagerResource getManagerResource()