com.vinculumtech.carrierwave.plansource
Class ClientSessionGraphPlanSource

java.lang.Object
  com.vinculumtech.carrierwave.plansource.ClientSessionGraphPlanSource

All Implemented Interfaces:

GraphPlanSource

public class ClientSessionGraphPlanSource

extends java.lang.Object

implements GraphPlanSource

Implementation of GraphPlanSource which retrieves GraphPlan instances from a ClientSession.

Version:

$Id: //depot/carrierwave/src/shared/com/vinculumtech/carrierwave/plansource/ClientSessionGraphPlanSource.java#7 $

Field Summary

static java.lang.Integer	AUTHORITY_ORDER
static java.lang.String	SOURCE_DESCRIPTION
static java.lang.String	SOURCE_NAME

Constructor Summary

ClientSessionGraphPlanSource(ClientSession clientSession)
Create a new ClientSessionGraphPlanSource using the specified ClientSession.

Method Summary

java.lang.Integer	getAuthorityOrder() Returns this GraphPlanSource instances authority value.
ClientSession	getClientSession()
protected RepositoryClient	getGraphPlanRepositoryClient()
java.lang.String	getSourceDescription()
java.lang.String	getSourceName()
boolean	isReadOnly()
java.util.List	listGraphPlanNames() Returns a list of available graph plan names.
boolean	removeGraphPlan(java.lang.String graphPlanName) Removes the GraphPlan instance specified by the given graphPlanName
GraphPlan	retrieveGraphPlan(java.lang.String graphPlanName)
protected void	setClientSession(ClientSession clientSession)
void	storeGraphPlan(GraphPlan graphPlan)

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_NAME

public static final java.lang.String SOURCE_NAME

See Also:

Constant Field Values

SOURCE_DESCRIPTION

public static final java.lang.String SOURCE_DESCRIPTION

See Also:

Constant Field Values

AUTHORITY_ORDER

public static final java.lang.Integer AUTHORITY_ORDER

Constructor Detail

ClientSessionGraphPlanSource

public ClientSessionGraphPlanSource(ClientSession clientSession)

Create a new ClientSessionGraphPlanSource using the specified ClientSession.

Method Detail

getClientSession

public ClientSession getClientSession()

setClientSession

protected void setClientSession(ClientSession clientSession)

getGraphPlanRepositoryClient

protected RepositoryClient getGraphPlanRepositoryClient()

getSourceName

public java.lang.String getSourceName()

Specified by:

getSourceName in interface GraphPlanSource

Returns:

the name of this GraphPlanSource instance

getSourceDescription

public java.lang.String getSourceDescription()

Specified by:

getSourceDescription in interface GraphPlanSource

Returns:

a String describing this GraphPlanSource instance

retrieveGraphPlan

public GraphPlan retrieveGraphPlan(java.lang.String graphPlanName)
                            throws GraphPlanException

Specified by:

retrieveGraphPlan in interface GraphPlanSource

Parameters:

graphPlanName -

Returns:

the GraphPlan designaged by the given graphPlanName

Throws:

GraphPlanException

storeGraphPlan

public void storeGraphPlan(GraphPlan graphPlan)
                    throws GraphPlanException

Specified by:

storeGraphPlan in interface GraphPlanSource

Parameters:

graphPlan - the GraphPlan instance to store

Throws:

GraphPlanException

removeGraphPlan

public boolean removeGraphPlan(java.lang.String graphPlanName)
                        throws GraphPlanException

Description copied from interface: GraphPlanSource

Removes the GraphPlan instance specified by the given graphPlanName

Specified by:

removeGraphPlan in interface GraphPlanSource

Parameters:

graphPlanName -

Returns:

true if the GraphPlan was found and removed, false otherwise

Throws:

GraphPlanException

listGraphPlanNames

public java.util.List listGraphPlanNames()
                                  throws GraphPlanException

Description copied from interface: GraphPlanSource

Returns a list of available graph plan names.

Specified by:

listGraphPlanNames in interface GraphPlanSource

Throws:

GraphPlanException

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface GraphPlanSource

Returns:

true if GraphPlan instances can not be stored or modifed in this GraphPlanSource instance

getAuthorityOrder

public java.lang.Integer getAuthorityOrder()

Description copied from interface: GraphPlanSource

Returns this GraphPlanSource instances authority value. The higher the authority value, the higher in precedence a given source is queried for a given GraphPlan by name.

Specified by:

getAuthorityOrder in interface GraphPlanSource

Returns:

the 'authority' value