com.tinkerpop.rexster.server.RexsterApplication Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rexster-core Show documentation
Core components for extending Rexster.
The newest version!
package com.tinkerpop.rexster.server;

import com.codahale.metrics.MetricRegistry;
import com.tinkerpop.blueprints.Graph;
import com.tinkerpop.rexster.RexsterApplicationGraph;

import java.util.Set;

/**
 * RexsterApplication is the interface that Rexster's servlets all delegate to in order to actually
 * retrieve or query graphs. A RexsterApplication owns all of the Graph instances that Rexster
 * serves.
 * 
 * Users interested in embedding Rexster into their graph store may want provide a custom
 * implementation of RexsterApplication that has logic to expose a Blueprints graph that
 * delegates to the relevant internal graph representations of their graph store.
 *
 * @author Stephen Mallette (http://stephen.genoprime.com)
 */
public interface RexsterApplication {
    /**
     * Retrieve the graph contained by the application graph with the given name
     *
     * @param graphName the name of the graph to retrieve
     * @return the Graph whose name is graphName, or null if it doesn't exist
     */
    Graph getGraph(final String graphName);

    /**
     * Retrieve a specific application graph
     *
     * @param graphName the name of the application graph to retrieve
     * @return the RexsterApplicationGraph whose name is graphName, or null if it doesn't exist
     */
    RexsterApplicationGraph getApplicationGraph(final String graphName);

    /**
     * Retrieve the names of all graphs that we are serving
     *
     * @return a set of the names of all graphs that we are serving
     */
    Set getGraphNames();

    /**
     * Rexster uses Metrics (http://metrics.codahale.com/) for gathering and reporting stats.
     *
     * Implementations should return a singleton of this object.  It can be instantiated very easily with something
     * like: new MetricRegistry("rexster") where the argument to the constructor is the name to give the object
     * collecting the metrics.
     *
     * @return a MetricsRegistry singleton.
     */
    MetricRegistry getMetricRegistry();

    /**
     * Retrieve the time at which we started serving graphs
     *
     * @return a long containing the time at which we starting serving graphs, in milliseconds
     */
    long getStartTime();

    /**
     * Stop serving graphs. Shuts down each of the graphs that we are serving.
     */
    void stop();
}