com.tinkerpop.rexster.extension
Class AbstractRexsterExtension

java.lang.Object
  extended by com.tinkerpop.rexster.extension.AbstractRexsterExtension
All Implemented Interfaces:
RexsterExtension
Direct Known Subclasses:
GremlinExtension

public abstract class AbstractRexsterExtension
extends Object
implements RexsterExtension

Base class for extensions.


Constructor Summary
AbstractRexsterExtension()
           
 
Method Summary
protected  org.codehaus.jettison.json.JSONObject generateErrorJson()
           
protected  org.codehaus.jettison.json.JSONObject generateErrorJson(org.codehaus.jettison.json.JSONObject api)
          Generates a standard JSON object with error information.
 boolean isConfigurationValid(ExtensionConfiguration extensionConfiguration)
          By default this returns true.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractRexsterExtension

public AbstractRexsterExtension()
Method Detail

isConfigurationValid

public boolean isConfigurationValid(ExtensionConfiguration extensionConfiguration)
By default this returns true. Overriding classes should evaluate the configuration to determine if it is correct.

Specified by:
isConfigurationValid in interface RexsterExtension
Returns:
True if the configuration is valid and false otherwise.

generateErrorJson

protected org.codehaus.jettison.json.JSONObject generateErrorJson()

generateErrorJson

protected org.codehaus.jettison.json.JSONObject generateErrorJson(org.codehaus.jettison.json.JSONObject api)
Generates a standard JSON object with error information.

Parameters:
api - Adds an API element to the error output. If null the key will not be added.


Copyright © 2009-2012. All Rights Reserved.