com.tinkerpop.rexster.extension
Annotation Type ExtensionDefinition


@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface ExtensionDefinition

Defines an extension method to rexster. Extensions may be applied to one of three extension points: graph, vertex and edge. This basically means that extensions can hang from any one of these resources in rexster.


Required Element Summary
 ExtensionPoint extensionPoint
          Defines the resource from which this extension is applied.
 
Optional Element Summary
 HttpMethod method
          The HTTP method that the extension method will support.
 String path
          Defines the path to the method extension.
 String produces
          Specifies the media type to be returned by the extension.
 boolean tryIncludeRexsterAttributes
          If the ExtensionDefinition is configured to produce JSON, setting this value to true will try to insert the Rexster version and query time attributes.
 

Element Detail

extensionPoint

public abstract ExtensionPoint extensionPoint
Defines the resource from which this extension is applied.

path

public abstract String path
Defines the path to the method extension.

Default:
""

tryIncludeRexsterAttributes

public abstract boolean tryIncludeRexsterAttributes
If the ExtensionDefinition is configured to produce JSON, setting this value to true will try to insert the Rexster version and query time attributes.

Default:
true

method

public abstract HttpMethod method
The HTTP method that the extension method will support. By default this is set to ANY which means any request will be passed through to the extension.

Default:
com.tinkerpop.rexster.extension.HttpMethod.ANY

produces

public abstract String produces
Specifies the media type to be returned by the extension. By default this value is application/json.

Default:
"application/json"


Copyright © 2009-2012. All Rights Reserved.