org.apache.ambari.server.api.resources

Class BaseResourceDefinition

java.lang.Object

org.apache.ambari.server.api.resources.BaseResourceDefinition

All Implemented Interfaces:

ResourceDefinition

Direct Known Subclasses:

ActionResourceDefinition, ActiveWidgetLayoutResourceDefinition, AlertDefResourceDefinition, AlertGroupResourceDefinition, AlertHistoryResourceDefinition, AlertNoticeResourceDefinition, AlertResourceDefinition, AlertTargetResourceDefinition, BlueprintResourceDefinition, ClientConfigResourceDefinition, ClusterResourceDefinition, ComponentResourceDefinition, ComponentStackVersionResourceDefinition, ConfigGroupResourceDefinition, ConfigurationResourceDefinition, CredentialResourceDefinition, DetachedHostResourceDefinition, ExtensionLinkResourceDefinition, ExtensionResourceDefinition, ExtensionVersionResourceDefinition, FeedResourceDefinition, GroupResourceDefinition, HostComponentProcessResourceDefinition, HostComponentResourceDefinition, HostKerberosIdentityResourceDefinition, HostResourceDefinition, InstanceResourceDefinition, JobResourceDefinition, LdapSyncEventResourceDefinition, LoggingResourceDefinition, MemberResourceDefinition, MpackResourceDefinition, OperatingSystemResourceDefinition, PermissionResourceDefinition, PrivilegeResourceDefinition, RecommendationResourceDefinition, RemoteClusterResourceDefinition, RepositoryResourceDefinition, RepositoryVersionResourceDefinition, RequestResourceDefinition, RequestScheduleResourceDefinition, RootServiceComponentResourceDefinition, RootServiceHostComponentResourceDefinition, RootServiceResourceDefinition, ServiceConfigVersionResourceDefinition, ServiceResourceDefinition, SimpleResourceDefinition, StackConfigurationDependencyResourceDefinition, StackConfigurationResourceDefinition, StackDependencyResourceDefinition, StackLevelConfigurationResourceDefinition, StackResourceDefinition, StackServiceComponentResourceDefinition, StackServiceResourceDefinition, StackVersionResourceDefinition, TargetClusterResourceDefinition, TaskAttemptResourceDefinition, TaskResourceDefinition, UserResourceDefinition, ValidationResourceDefinition, VersionDefinitionResourceDefinition, ViewExternalSubResourceDefinition, ViewInstanceResourceDefinition, ViewPermissionResourceDefinition, ViewResourceDefinition, ViewSubResourceDefinition, ViewUrlResourceDefinition, ViewVersionResourceDefinition, WidgetLayoutResourceDefinition, WidgetResourceDefinition, WorkflowResourceDefinition

public abstract class BaseResourceDefinition
extends Object
implements ResourceDefinition

Base resource definition. Contains behavior common to all resource types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseResourceDefinition.DirectiveType

Nested classes/interfaces inherited from interface org.apache.ambari.server.api.resources.ResourceDefinition

ResourceDefinition.PostProcessor

Constructor Summary

Constructors

Constructor and Description
BaseResourceDefinition(Resource.Type resourceType) Constructor.
BaseResourceDefinition(Resource.Type resourceType, Collection<Resource.Type> subTypes, Map<BaseResourceDefinition.DirectiveType,? extends Collection<String>> directives) Constructor.
BaseResourceDefinition(Resource.Type resourceType, Resource.Type... subTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Collection<String>	getCreateDirectives() Obtain the set of create directives for the resource.
Collection<String>	getDeleteDirectives() Obtain the set of delete directives for the resource.
List<ResourceDefinition.PostProcessor>	getPostProcessors() Obtain any resource post processors.
Collection<String>	getReadDirectives() Obtain the set of read directives for the resource.
Renderer	getRenderer(String name) Obtain the associated renderer based on name.
Set<SubResourceDefinition>	getSubResourceDefinitions() Obtain a set of all child resource types.
Resource.Type	getType() Obtain the type of resource.
Collection<String>	getUpdateDirectives() Obtain the set of update directives for the resource.
int	hashCode()
boolean	isCreatable() Defines if resource is actually created on the server side during POST operation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.api.resources.ResourceDefinition

getPluralName, getSingularName

Constructor Detail

BaseResourceDefinition

public BaseResourceDefinition(Resource.Type resourceType)

Constructor.

Parameters:

resourceType - resource type

BaseResourceDefinition

public BaseResourceDefinition(Resource.Type resourceType,
                              Resource.Type... subTypes)

Constructor.

Parameters:

resourceType - the resource type

subTypes - the sub-resource types

BaseResourceDefinition

public BaseResourceDefinition(Resource.Type resourceType,
                              Collection<Resource.Type> subTypes,
                              Map<BaseResourceDefinition.DirectiveType,? extends Collection<String>> directives)

Constructor.

Parameters:

resourceType - the resource type

subTypes - the sub-resource types

directives - a map of directives for request types for this resource

Method Detail

getType

public Resource.Type getType()

Description copied from interface: ResourceDefinition

Obtain the type of resource. Is one of Resource.Type.

Specified by:

getType in interface ResourceDefinition

Returns:

the type of resource

getSubResourceDefinitions

public Set<SubResourceDefinition> getSubResourceDefinitions()

Description copied from interface: ResourceDefinition

Obtain a set of all child resource types.

Specified by:

getSubResourceDefinitions in interface ResourceDefinition

Returns:

set of sub-resource definitions

getPostProcessors

public List<ResourceDefinition.PostProcessor> getPostProcessors()

Description copied from interface: ResourceDefinition

Obtain any resource post processors. A resource processor is used to provide resource specific processing of results and is called by the ResultPostProcessor while post processing a result.

Specified by:

getPostProcessors in interface ResourceDefinition

Returns:

list of resource specific result processors

getRenderer

public Renderer getRenderer(String name)

Description copied from interface: ResourceDefinition

Obtain the associated renderer based on name.

Specified by:

getRenderer in interface ResourceDefinition

Parameters:

name - name of the renderer to obtain

Returns:

associated renderer instance

getReadDirectives

public Collection<String> getReadDirectives()

Description copied from interface: ResourceDefinition

Obtain the set of read directives for the resource. A get directive is information that can be provided in the query string of a GET operation for the resource. These directives are not predicates but are put into the map of request info properties used by the resource provider when getting the resource.

Specified by:

getReadDirectives in interface ResourceDefinition

getCreateDirectives

public Collection<String> getCreateDirectives()

Description copied from interface: ResourceDefinition

Obtain the set of create directives for the resource. A create directive is information that can be provided in the query string of a POST operation for the resource. These directives are not predicates but are put into the map of request info properties used by the resource provider when creating the resource.

Specified by:

getCreateDirectives in interface ResourceDefinition

getUpdateDirectives

public Collection<String> getUpdateDirectives()

Description copied from interface: ResourceDefinition

Obtain the set of update directives for the resource. An update directive is information that can be provided in the query string of a PUT operation for the resource. These directives are not predicates but are put into the map of request info properties used by the resource provider when updating the resource.

Specified by:

getUpdateDirectives in interface ResourceDefinition

getDeleteDirectives

public Collection<String> getDeleteDirectives()

Description copied from interface: ResourceDefinition

Obtain the set of delete directives for the resource. A delete directive is information that can be provided in the query string of a DELETE operation for the resource. These directives are not predicates but are put into the map of request info properties used by the resource provider when updating the resource.

Specified by:

getDeleteDirectives in interface ResourceDefinition

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCreatable

public boolean isCreatable()

Description copied from interface: ResourceDefinition

Defines if resource is actually created on the server side during POST operation.

Specified by:

isCreatable in interface ResourceDefinition

Returns:

true if resource is creatable, false otherwise

See Also:

http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.5