ResourceDefinition (Ambari Server 3.0.0.0-SNAPSHOT API)

All Known Implementing Classes:

ActionResourceDefinition, ActiveWidgetLayoutResourceDefinition, AlertDefResourceDefinition, AlertGroupResourceDefinition, AlertHistoryResourceDefinition, AlertNoticeResourceDefinition, AlertResourceDefinition, AlertTargetResourceDefinition, BaseResourceDefinition, BlueprintResourceDefinition, ClientConfigResourceDefinition, ClusterResourceDefinition, CompatibleRepositoryVersionDefinition, 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, UpgradeResourceDefinition, UserResourceDefinition, ValidationResourceDefinition, VersionDefinitionResourceDefinition, ViewExternalSubResourceDefinition, ViewInstanceResourceDefinition, ViewPermissionResourceDefinition, ViewResourceDefinition, ViewSubResourceDefinition, ViewUrlResourceDefinition, ViewVersionResourceDefinition, WidgetLayoutResourceDefinition, WidgetResourceDefinition, WorkflowResourceDefinition
```
public interface ResourceDefinition
```
Resource Definition. Provides information specific to a specific resource type.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface ResourceDefinition.PostProcessor
Resource specific result processor.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ResourceDefinition.PostProcessor` Resource specific result processor.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Collection<String>`	`getCreateDirectives()` Obtain the set of create directives for the resource.
`Collection<String>`	`getDeleteDirectives()` Obtain the set of delete directives for the resource.
`String`	`getPluralName()` Obtain the plural name of 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.
`String`	`getSingularName()` Obtain the singular name of the resource.
`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.
`boolean`	`isCreatable()` Defines if resource is actually created on the server side during POST operation.

- Method Detail
  - getPluralName
```
String getPluralName()
```
    Obtain the plural name of the resource.
    
    Returns:
    
    the plural name of the resource
  - getSingularName
```
String getSingularName()
```
    Obtain the singular name of the resource.
    
    Returns:
    
    the singular name of the resource
  - getType
```
Resource.Type getType()
```
    Obtain the type of resource. Is one of Resource.Type.
    
    Returns:
    
    the type of resource
  - getSubResourceDefinitions
```
Set<SubResourceDefinition> getSubResourceDefinitions()
```
    Obtain a set of all child resource types.
    
    Returns:
    
    set of sub-resource definitions
  - getPostProcessors
```
List<ResourceDefinition.PostProcessor> getPostProcessors()
```
    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.
    
    Returns:
    
    list of resource specific result processors
  - getRenderer
```
Renderer getRenderer(String name)
              throws IllegalArgumentException
```
    Obtain the associated renderer based on name.
    
    Parameters:
    
    name - name of the renderer to obtain
    
    Returns:
    
    associated renderer instance
    
    Throws:
    
    IllegalArgumentException - if name is invalid for this resource
  - getReadDirectives
```
Collection<String> getReadDirectives()
```
    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.
  - getCreateDirectives
```
Collection<String> getCreateDirectives()
```
    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.
  - getUpdateDirectives
```
Collection<String> getUpdateDirectives()
```
    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.
  - getDeleteDirectives
```
Collection<String> getDeleteDirectives()
```
    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.
  - isCreatable
```
boolean isCreatable()
```
    Defines if resource is actually created on the server side during POST operation.
    
    Returns:
    
    true if resource is creatable, false otherwise
    
    See Also:
    
    http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.5

Interface ResourceDefinition

Nested Class Summary

Method Summary

Method Detail

getPluralName

getSingularName

getType

getSubResourceDefinitions

getPostProcessors

getRenderer

getReadDirectives

getCreateDirectives

getUpdateDirectives

getDeleteDirectives

isCreatable