org.apache.brooklyn.rest.resources

Class EntityResource

java.lang.Object

org.apache.brooklyn.rest.resources.AbstractBrooklynRestResource

org.apache.brooklyn.rest.resources.EntityResource

All Implemented Interfaces:

EntityApi

public class EntityResource
extends AbstractBrooklynRestResource
implements EntityApi

Nested Class Summary

Nested Classes

Modifier and Type

Class and Description

static class

EntityResource.InterestingTasksFirstComparator API does not guarantee order, but this is a the one we use (when there are lots of tasks): prefer top-level tasks and to recent tasks, balanced such that the following are equal: something manually submitted here, submitted two hours ago something submitted from another entity, submitted ten minutes ago anything in progress, submitted one minute ago anything not started, submitted ten seconds ago anything completed, submitted one second ago

Nested classes/interfaces inherited from class org.apache.brooklyn.rest.resources.AbstractBrooklynRestResource

AbstractBrooklynRestResource.RestValueResolver

Constructor Summary

Constructors

Constructor and Description
EntityResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addChildren(java.lang.String applicationToken, java.lang.String entityToken, java.lang.Boolean start, java.lang.String timeoutS, java.lang.String yaml)
javax.ws.rs.core.Response	expunge(java.lang.String application, java.lang.String entity, boolean release)
EntitySummary	get(java.lang.String application, java.lang.String entityName)
java.util.List<EntitySummary>	getChildren(java.lang.String application, java.lang.String entity)
java.util.List<EntitySummary>	getDescendants(java.lang.String application, java.lang.String entity, java.lang.String typeRegex)
java.util.Map<java.lang.String,java.lang.Object>	getDescendantsSensor(java.lang.String application, java.lang.String entity, java.lang.String sensor, java.lang.String typeRegex)
javax.ws.rs.core.Response	getIcon(java.lang.String applicationId, java.lang.String entityId)
java.util.List<LocationSummary>	getLocations(java.lang.String application, java.lang.String entity)
java.lang.String	getSpec(java.lang.String applicationToken, java.lang.String entityToken)
TaskSummary	getTask(java.lang.String application, java.lang.String entityToken, java.lang.String taskId)
java.util.List<EntitySummary>	list(java.lang.String application)
java.util.List<java.lang.Object>	listTags(java.lang.String applicationId, java.lang.String entityId)
java.util.List<TaskSummary>	listTasks(java.lang.String applicationId, java.lang.String entityId) Deprecated.
java.util.List<TaskSummary>	listTasks(java.lang.String applicationId, java.lang.String entityId, int limit, java.lang.Boolean recurse)
javax.ws.rs.core.Response	rename(java.lang.String application, java.lang.String entity, java.lang.String newName)

Methods inherited from class org.apache.brooklyn.rest.resources.AbstractBrooklynRestResource

brooklyn, mgmt, mgmtInternal, setManagementContext

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityResource

public EntityResource()

Method Detail

list

public java.util.List<EntitySummary> list(java.lang.String application)

Specified by:

list in interface EntityApi

get

public EntitySummary get(java.lang.String application,
                         java.lang.String entityName)

Specified by:

get in interface EntityApi

getChildren

public java.util.List<EntitySummary> getChildren(java.lang.String application,
                                                 java.lang.String entity)

Specified by:

getChildren in interface EntityApi

addChildren

public javax.ws.rs.core.Response addChildren(java.lang.String applicationToken,
                                             java.lang.String entityToken,
                                             java.lang.Boolean start,
                                             java.lang.String timeoutS,
                                             java.lang.String yaml)

Specified by:

addChildren in interface EntityApi

listTasks

public java.util.List<TaskSummary> listTasks(java.lang.String applicationId,
                                             java.lang.String entityId,
                                             int limit,
                                             java.lang.Boolean recurse)

Specified by:

listTasks in interface EntityApi

listTasks

@Deprecated
public java.util.List<TaskSummary> listTasks(java.lang.String applicationId,
                                                         java.lang.String entityId)

Deprecated.

Specified by:

listTasks in interface EntityApi

getTask

public TaskSummary getTask(java.lang.String application,
                           java.lang.String entityToken,
                           java.lang.String taskId)

Specified by:

getTask in interface EntityApi

listTags

public java.util.List<java.lang.Object> listTags(java.lang.String applicationId,
                                                 java.lang.String entityId)

Specified by:

listTags in interface EntityApi

getIcon

public javax.ws.rs.core.Response getIcon(java.lang.String applicationId,
                                         java.lang.String entityId)

Specified by:

getIcon in interface EntityApi

rename

public javax.ws.rs.core.Response rename(java.lang.String application,
                                        java.lang.String entity,
                                        java.lang.String newName)

Specified by:

rename in interface EntityApi

expunge

public javax.ws.rs.core.Response expunge(java.lang.String application,
                                         java.lang.String entity,
                                         boolean release)

Specified by:

expunge in interface EntityApi

getDescendants

public java.util.List<EntitySummary> getDescendants(java.lang.String application,
                                                    java.lang.String entity,
                                                    java.lang.String typeRegex)

Specified by:

getDescendants in interface EntityApi

getDescendantsSensor

public java.util.Map<java.lang.String,java.lang.Object> getDescendantsSensor(java.lang.String application,
                                                                             java.lang.String entity,
                                                                             java.lang.String sensor,
                                                                             java.lang.String typeRegex)

Specified by:

getDescendantsSensor in interface EntityApi

getLocations

public java.util.List<LocationSummary> getLocations(java.lang.String application,
                                                    java.lang.String entity)

Specified by:

getLocations in interface EntityApi

getSpec

public java.lang.String getSpec(java.lang.String applicationToken,
                                java.lang.String entityToken)

Specified by:

getSpec in interface EntityApi