org.apache.falcon.resource.proxy
Class SchedulableEntityManagerProxy

java.lang.Object
  extended by org.apache.falcon.resource.AbstractEntityManager
      extended by org.apache.falcon.resource.AbstractSchedulableEntityManager
          extended by org.apache.falcon.resource.proxy.SchedulableEntityManagerProxy

public class SchedulableEntityManagerProxy
extends AbstractSchedulableEntityManager

A proxy implementation of the schedulable entity operations.


Field Summary
 
Fields inherited from class org.apache.falcon.resource.AbstractEntityManager
configStore, XML_DEBUG_LEN
 
Constructor Summary
SchedulableEntityManagerProxy()
           
 
Method Summary
 org.apache.falcon.resource.APIResult delete(javax.servlet.http.HttpServletRequest request, String type, String entity, String ignore)
          Deletes a scheduled entity, a deleted entity is removed completely from execution pool.
 org.apache.falcon.resource.EntityList getDependencies(String type, String entity)
          Returns dependencies.
 String getEntityDefinition(String type, String entityName)
          Returns the entity definition as an XML based on name.
 org.apache.falcon.resource.EntityList getEntityList(String type, String fields)
          Returns the list of entities registered of a given type.
 org.apache.falcon.resource.APIResult getStatus(String type, String entity, String coloExpr)
          Returns the status of requested entity.
 org.apache.falcon.resource.APIResult resume(javax.servlet.http.HttpServletRequest request, String type, String entity, String coloExpr)
          Resumes a suspended entity.
 org.apache.falcon.resource.APIResult schedule(javax.servlet.http.HttpServletRequest request, String type, String entity, String coloExpr)
          Schedules an submitted entity immediately.
 org.apache.falcon.resource.APIResult submit(javax.servlet.http.HttpServletRequest request, String type, String ignore)
          Submit a new entity.
 org.apache.falcon.resource.APIResult submitAndSchedule(javax.servlet.http.HttpServletRequest request, String type, String coloExpr)
          Submits a new entity and schedules it immediately.
 org.apache.falcon.resource.APIResult suspend(javax.servlet.http.HttpServletRequest request, String type, String entity, String coloExpr)
          Suspends a running entity.
 org.apache.falcon.resource.APIResult update(javax.servlet.http.HttpServletRequest request, String type, String entityName, String ignore)
           
 org.apache.falcon.resource.APIResult validate(javax.servlet.http.HttpServletRequest request, String type)
          Post an entity XML with entity type.
 
Methods inherited from class org.apache.falcon.resource.AbstractEntityManager
audit, checkColo, deserializeEntity, getAllColos, getApplicableColos, getApplicableColos, getColosFromExpression, getStatus, getWorkflowEngine, submitInternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SchedulableEntityManagerProxy

public SchedulableEntityManagerProxy()
Method Detail

submit

public org.apache.falcon.resource.APIResult submit(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String type,
                                                   String ignore)
Description copied from class: AbstractEntityManager
Submit a new entity. Entities can be of type feed, process or data end points. Entity definitions are validated structurally against schema and subsequently for other rules before they are admitted into the system

Entity name acts as the key and an entity once added, can't be added again unless deleted.

Overrides:
submit in class AbstractEntityManager
Parameters:
request - - Servlet Request
type - - entity type - feed, process or data end point
ignore - - applicable colo
Returns:
result of the operation

validate

public org.apache.falcon.resource.APIResult validate(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String type)
Description copied from class: AbstractEntityManager
Post an entity XML with entity type. Validates the XML which can be Process, Feed or Dataendpoint

Overrides:
validate in class AbstractEntityManager
type - entity type
Returns:
APIResule -Succeeded or Failed

delete

public org.apache.falcon.resource.APIResult delete(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String type,
                                                   String entity,
                                                   String ignore)
Description copied from class: AbstractEntityManager
Deletes a scheduled entity, a deleted entity is removed completely from execution pool.

Overrides:
delete in class AbstractEntityManager
type - entity type
entity - entity name
Returns:
APIResult

update

public org.apache.falcon.resource.APIResult update(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String type,
                                                   String entityName,
                                                   String ignore)
Overrides:
update in class AbstractEntityManager

getStatus

public org.apache.falcon.resource.APIResult getStatus(String type,
                                                      String entity,
                                                      String coloExpr)
Description copied from class: AbstractEntityManager
Returns the status of requested entity.

Overrides:
getStatus in class AbstractEntityManager
Parameters:
type - entity type
entity - entity name
Returns:
String

getDependencies

public org.apache.falcon.resource.EntityList getDependencies(String type,
                                                             String entity)
Description copied from class: AbstractEntityManager
Returns dependencies.

Overrides:
getDependencies in class AbstractEntityManager
Parameters:
type - entity type
entity - entity name
Returns:
EntityList

getEntityList

public org.apache.falcon.resource.EntityList getEntityList(String type,
                                                           String fields)
Description copied from class: AbstractEntityManager
Returns the list of entities registered of a given type.

Overrides:
getEntityList in class AbstractEntityManager
Parameters:
type - entity type
fields - fields that the query is interested in, separated by comma
Returns:
String

getEntityDefinition

public String getEntityDefinition(String type,
                                  String entityName)
Description copied from class: AbstractEntityManager
Returns the entity definition as an XML based on name.

Overrides:
getEntityDefinition in class AbstractEntityManager
Parameters:
type - entity type
entityName - entity name
Returns:
String

schedule

public org.apache.falcon.resource.APIResult schedule(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String type,
                                                     String entity,
                                                     String coloExpr)
Description copied from class: AbstractSchedulableEntityManager
Schedules an submitted entity immediately.

Overrides:
schedule in class AbstractSchedulableEntityManager
Returns:
APIResult

submitAndSchedule

public org.apache.falcon.resource.APIResult submitAndSchedule(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              String type,
                                                              String coloExpr)
Description copied from class: AbstractSchedulableEntityManager
Submits a new entity and schedules it immediately.

Overrides:
submitAndSchedule in class AbstractSchedulableEntityManager
Returns:

suspend

public org.apache.falcon.resource.APIResult suspend(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String type,
                                                    String entity,
                                                    String coloExpr)
Description copied from class: AbstractSchedulableEntityManager
Suspends a running entity.

Overrides:
suspend in class AbstractSchedulableEntityManager
Returns:
APIResult

resume

public org.apache.falcon.resource.APIResult resume(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String type,
                                                   String entity,
                                                   String coloExpr)
Description copied from class: AbstractSchedulableEntityManager
Resumes a suspended entity.

Overrides:
resume in class AbstractSchedulableEntityManager
Returns:
APIResult


Copyright © 2013-2014 Apache Software Foundation. All Rights Reserved.