Package com.franz.agraph.http

Class AGProtocol

java.lang.Object
org.eclipse.rdf4j.http.protocol.Protocol
com.franz.agraph.http.AGProtocol
public class AGProtocol extends Protocol

  • Field Details

    • CATALOGS

      public static final String CATALOGS
      Relative location of the catalogs service.
      See Also:

    • VERSION

      public static final String VERSION
      Relative location of the version service.
      See Also:

    • RECONFIGURE

      public static final String RECONFIGURE
      Relative location of the reconfigure service.
      See Also:

    • USERS

      public static final String USERS
      Relative location of the users service.
      See Also:

    • USER_ROLES

      public static final String USER_ROLES
      Relative location of the user roles service.
      See Also:

    • USER_PERMISSIONS

      public static final String USER_PERMISSIONS
      Relative location of the user permissions service.
      See Also:

    • USER_DATA

      public static final String USER_DATA
      Relative location of the user data service.
      See Also:

    • PROCESSES

      public static final String PROCESSES
      Relative location of the processes service.
      See Also:

    • SESSION

      public static final String SESSION
      Relative location of the session service.
      See Also:

    • LIFETIME_PARAM_NAME

      public static final String LIFETIME_PARAM_NAME
      Parameter name for the 'lifetime' parameter for sessions.
      See Also:

    • LOAD_INIT_FILE_PARAM_NAME

      public static final String LOAD_INIT_FILE_PARAM_NAME
      Parameter name for the 'loadInitFile' parameter for sessions.
      See Also:

    • AUTOCOMMIT_PARAM_NAME

      public static final String AUTOCOMMIT_PARAM_NAME
      Parameter name for the 'autoCommit' parameter for sessions.
      See Also:

    • OVERRIDE_PARAM_NAME

      public static final String OVERRIDE_PARAM_NAME
      Parameter name for the 'override' parameter for put on a repository.
      See Also:

    • CLOSE

      public static final String CLOSE
      Relative location of session close.
      See Also:

    • PING

      public static final String PING
      Relative location of the session ping service.
      See Also:

    • QUERIES

      public static final String QUERIES
      Relative location of the session prepared queries service.
      See Also:

    • BLANK_NODES

      public static final String BLANK_NODES
      Relative location of the blank nodes service.
      See Also:

    • AMOUNT_PARAM_NAME

      public static final String AMOUNT_PARAM_NAME
      Parameter name for the 'amount' parameter of blank node service.
      See Also:

    • DELETE

      public static final String DELETE
      Relative location to delete statements.
      See Also:

    • AUTOCOMMIT

      public static final String AUTOCOMMIT
      Relative location of the autocommit service.
      See Also:

    • CUSTOM

      public static final String CUSTOM
      Relative location of the custom stored proc service.
      See Also:

    • ON_PARAM_NAME

      public static final String ON_PARAM_NAME
      Parameter name for the 'on' parameter of autoCommit.
      See Also:

    • FILE_PARAM_NAME

      public static final String FILE_PARAM_NAME
      Parameter name for the 'file' parameter for statements.
      See Also:

    • COMMIT

      public static final String COMMIT
      Relative location of the commit service.
      See Also:

    • COMMIT_PHASE

      public static final String COMMIT_PHASE
      Parameter name for the 'phase' parameter for the commit service.
      See Also:

    • XID

      public static final String XID
      Parameter name for the 'xid' parameter for the commit/rollback services
      See Also:

    • ROLLBACK

      public static final String ROLLBACK
      Relative location of the rollback service.
      See Also:

    • GET_PREPARED_TRANSACTIONS

      public static final String GET_PREPARED_TRANSACTIONS
      Relative location of the getPreparedTransactions
      See Also:

    • EVAL

      public static final String EVAL
      Relative location of the eval service.
      See Also:

    • FUNCTOR

      public static final String FUNCTOR
      Relative location of the functor service.
      See Also:

    • FREETEXT

      public static final String FREETEXT
      Relative location of the freetext service.
      See Also:

    • FTI_INDICES

      public static final String FTI_INDICES
      Relative location of the freetext predicates service.
      See Also:

    • FTI_PREDICATE_PARAM_NAME

      public static final String FTI_PREDICATE_PARAM_NAME
      Parameter name for the 'predicate' parameter for freetext.
      See Also:

    • MAPPING

      public static final String MAPPING
      Relative location of the mapping service.
      See Also:

    • MAPPING_DATATYPE

      public static final String MAPPING_DATATYPE
      Relative location of the datatype mapping service.
      See Also:

    • TYPE_PARAM_NAME

      public static final String TYPE_PARAM_NAME
      Parameter name for the 'type' parameter for datatype mapping.
      See Also:

    • ENCODED_TYPE_PARAM_NAME

      public static final String ENCODED_TYPE_PARAM_NAME
      Parameter name for the 'encoding' parameter for mappings.
      See Also:

    • MAPPING_PREDICATE

      public static final String MAPPING_PREDICATE
      Relative location of the predicate mapping service.
      See Also:

    • URL_PARAM_NAME

      public static final String URL_PARAM_NAME
      Parameter name for the 'url' parameter for federation.
      See Also:

    • REPO_PARAM_NAME

      public static final String REPO_PARAM_NAME
      Parameter name for the 'repo' parameter for federation
      See Also:

    • PLANNER_PARAM_NAME

      public static final String PLANNER_PARAM_NAME
      Parameter name for the 'planner' to use during a query
      See Also:

    • SAVE_PARAM_NAME

      public static final String SAVE_PARAM_NAME
      Parameter name for the name to 'save' a prepared query
      See Also:

    • GEO

      public static final String GEO
      Relative location of the Geo service.
      See Also:

    • TYPES

      public static final String TYPES
      Relative location of the Geo Types service.
      See Also:

    • CARTESIAN

      public static final String CARTESIAN
      Relative location of the Geo Types Cartesian service.
      See Also:

    • SPHERICAL

      public static final String SPHERICAL
      Relative location of the Geo Types Spherical service.
      See Also:

    • STRIP_WIDTH_PARAM_NAME

      public static final String STRIP_WIDTH_PARAM_NAME
      Parameter name for the 'stripWidth' of a Geo type
      See Also:

    • XMIN_PARAM_NAME

      public static final String XMIN_PARAM_NAME
      Parameter name for the 'xmin' of a Geo type
      See Also:

    • XMAX_PARAM_NAME

      public static final String XMAX_PARAM_NAME
      Parameter name for the 'xmax' of a Geo type
      See Also:

    • YMIN_PARAM_NAME

      public static final String YMIN_PARAM_NAME
      Parameter name for the 'ymin' of a Geo type
      See Also:

    • YMAX_PARAM_NAME

      public static final String YMAX_PARAM_NAME
      Parameter name for the 'ymax' of a Geo type
      See Also:

    • LATMIN_PARAM_NAME

      public static final String LATMIN_PARAM_NAME
      Parameter name for the 'latmin' of a Geo type
      See Also:

    • LONGMIN_PARAM_NAME

      public static final String LONGMIN_PARAM_NAME
      Parameter name for the 'longmin' of a Geo type
      See Also:

    • LATMAX_PARAM_NAME

      public static final String LATMAX_PARAM_NAME
      Parameter name for the 'latmax' of a Geo type
      See Also:

    • LONGMAX_PARAM_NAME

      public static final String LONGMAX_PARAM_NAME
      Parameter name for the 'longmax' of a Geo type
      See Also:

    • UNIT_PARAM_NAME

      public static final String UNIT_PARAM_NAME
      Parameter name for the 'unit' of a Geo type
      See Also:

    • DEGREE_PARAM_VALUE

      public static final String DEGREE_PARAM_VALUE
      Parameter value 'degree' for the 'unit' of a Geo type
      See Also:

    • RADIAN_PARAM_VALUE

      public static final String RADIAN_PARAM_VALUE
      Parameter value 'radian' for the 'unit' of a Geo type
      See Also:

    • KM_PARAM_VALUE

      public static final String KM_PARAM_VALUE
      Parameter value 'km' for the 'unit' of a Geo type
      See Also:

    • MILE_PARAM_VALUE

      public static final String MILE_PARAM_VALUE
      Parameter value 'mile' for the 'unit' of a Geo type
      See Also:

    • LIMIT_PARAM_NAME

      public static final String LIMIT_PARAM_NAME
      Parameter name for the 'limit' on results returned.
      See Also:

    • BOX

      public static final String BOX
      Relative location of the Geo Box service.
      See Also:

    • GEO_PREDICATE_PARAM_NAME

      public static final String GEO_PREDICATE_PARAM_NAME
      Parameter name for the 'predicate' to search for in geo searches.
      See Also:

    • CIRCLE

      public static final String CIRCLE
      Relative location of the Geo Circle service.
      See Also:

    • X_PARAM_NAME

      public static final String X_PARAM_NAME
      Parameter name for the 'x' ordinate of a circle
      See Also:

    • Y_PARAM_NAME

      public static final String Y_PARAM_NAME
      Parameter name for the 'y' ordinate of a circle
      See Also:

    • RADIUS_PARAM_NAME

      public static final String RADIUS_PARAM_NAME
      Parameter name for the 'radius' of a circle
      See Also:

    • HAVERSINE

      public static final String HAVERSINE
      Relative location of the Geo Haversine service.
      See Also:

    • LAT_PARAM_NAME

      public static final String LAT_PARAM_NAME
      Parameter name for the 'lat' ordinate of a haversine
      See Also:

    • LON_PARAM_NAME

      public static final String LON_PARAM_NAME
      Parameter name for the 'lon' ordinate of a haversine
      See Also:

    • POLYGON

      public static final String POLYGON
      Relative location of the Geo Polygon registration service.
      See Also:

    • RESOURCE_PARAM_NAME

      public static final String RESOURCE_PARAM_NAME
      Parameter name 'resource' for the polygon being registered
      See Also:

    • POLYGON_PARAM_NAME

      public static final String POLYGON_PARAM_NAME
      Parameter name for the 'polygon' being referenced
      See Also:

    • POINT_PARAM_NAME

      public static final String POINT_PARAM_NAME
      Parameter name for the 'point' of a polygon
      See Also:

    • SNA_GENERATORS

      public static final String SNA_GENERATORS
      Relative location of the SNA Generators registration service.
      See Also:

    • OBJECTOF_PARAM_NAME

      public static final String OBJECTOF_PARAM_NAME
      Parameter name for the 'objectOf' predicates in the generator
      See Also:

    • SUBJECTOF_PARAM_NAME

      public static final String SUBJECTOF_PARAM_NAME
      Parameter name for the 'subjectOf' predicates in the generator
      See Also:

    • UNDIRECTED_PARAM_NAME

      public static final String UNDIRECTED_PARAM_NAME
      Parameter name for the 'undirected' predicates in the generator
      See Also:

    • NEIGHBOR_MATRICES

      public static final String NEIGHBOR_MATRICES
      Relative location of the SNA Neighbor Matrices registration service.
      See Also:

    • GENERATOR_PARAM_NAME

      public static final String GENERATOR_PARAM_NAME
      Parameter name for the 'generator' for the neighbor matrix
      See Also:

    • GROUP_PARAM_NAME

      public static final String GROUP_PARAM_NAME
      Parameter name for the 'group' used in seeding a neighbor matrix
      See Also:

    • DEPTH_PARAM_NAME

      public static final String DEPTH_PARAM_NAME
      Parameter name for the 'depth' for the neighbor matrix
      See Also:

    • INDICES

      public static final String INDICES
      Relative location of the INDICES service.
      See Also:

    • SPIN

      public static final String SPIN
      See Also:

    • SPIN_MAGICPROPERTY

      public static final String SPIN_MAGICPROPERTY
      See Also:

    • SPIN_FUNCTION

      public static final String SPIN_FUNCTION
      See Also:

    • SPIN_QUERY

      public static final String SPIN_QUERY
      See Also:

    • SPIN_ARGUMENTS

      public static final String SPIN_ARGUMENTS
      See Also:

    • WARMUP

      public static final String WARMUP
      Relative location of the warmup service.
      See Also:

    • INCLUDE_STRINGS

      public static final String INCLUDE_STRINGS
      See Also:

    • INCLUDE_TRIPLES

      public static final String INCLUDE_TRIPLES
      See Also:

    • LOGFILE

      public static final String LOGFILE
      Location of the log service.
      See Also:

    • CHECK_VARIABLES

      public static final String CHECK_VARIABLES
      A boolean that defaults to false, indicating whether an error should be raised when a SPARQL query selects variables that are not mentioned in the query body.
      See Also:

    • SESSION_DOC

      public static final String SESSION_DOC
      See Also:

    • BEGIN

      public static final String BEGIN
      Relative location of the begin service.
      See Also:

    • DEFINE_ATTRIBUTE_LOCATION

      public static final String DEFINE_ATTRIBUTE_LOCATION
      Relative location of the attribute definition service
      See Also:

    • NAME_PARAM_NAME

      public static final String NAME_PARAM_NAME
      attribute definition request parameters
      See Also:

    • ORDERED_PARAM_NAME

      public static final String ORDERED_PARAM_NAME
      attribute definition request parameters
      See Also:

    • ALLOWED_VALUE_PARAM_NAME

      public static final String ALLOWED_VALUE_PARAM_NAME
      attribute definition request parameters
      See Also:

    • MAXIMUM_PARAM_NAME

      public static final String MAXIMUM_PARAM_NAME
      attribute definition request parameters
      See Also:

    • MINIMUM_PARAM_NAME

      public static final String MINIMUM_PARAM_NAME
      attribute definition request parameters
      See Also:

    • ATTRIBUTES_PARAM_NAME

      public static final String ATTRIBUTES_PARAM_NAME
      Used by the /statements service
      See Also:

    • OVERRIDE_CONTEXT_PARAM_NAME

      public static final String OVERRIDE_CONTEXT_PARAM_NAME
      Used by the /statements service to override the context present in the data being loaded with the the supplied one.
      See Also:

    • PROP_OVERRIDE_CONTEXT

      public static final String PROP_OVERRIDE_CONTEXT
      The name of the system property used to toggle context overriding behaviour.
      See Also:

    • STATIC_FILTER_LOCATION

      public static final String STATIC_FILTER_LOCATION
      Relative location of static attribute filter service
      See Also:

    • ND_GEOSPATIAL_DATATYPE_AUTOMATION

      public static final String ND_GEOSPATIAL_DATATYPE_AUTOMATION
      See Also:

    • QUERY_OPTIONS

      public static final String QUERY_OPTIONS
      Relativec location of the query options services prefix.
      See Also:

    • FILTER_PARAM_NAME

      public static final String FILTER_PARAM_NAME
      See Also:

    • USER_ATTRIBUTE_HEADER

      public static final String USER_ATTRIBUTE_HEADER
      Override header for supplying user attributes with a store-based request.
      See Also:

    • X_COMMIT_HEADER

      public static final String X_COMMIT_HEADER
      Headers for requesting rollback and commit as part of a request
      See Also:

    • X_ROLLBACK_HEADER

      public static final String X_ROLLBACK_HEADER
      See Also:

    • X_REPL_SETTINGS

      public static final String X_REPL_SETTINGS
      Header used to transfer settings related to multi-master replication.
      See Also:

  • Constructor Details

    • AGProtocol

      public AGProtocol()

  • Method Details

    • getLogLocation

      public static String getLogLocation(String serverURL)
      Get the location of the server logs resource on the specified server.
      Parameters:
      serverURL - the base location of a server implementing this REST protocol.
      Returns:
      the location of the server logs resource on the specified server

    • getRootCatalogURL

      public static final String getRootCatalogURL(String serverURL)
      Location of the root catalog service
      Parameters:
      serverURL - the server url
      Returns:
      String the root catalog service location

    • getNamedCatalogsURL

      public static final String getNamedCatalogsURL(String serverURL)
      Location of the named catalog's service
      Parameters:
      serverURL - the server url
      Returns:
      String the named catalog's service location

    • getNamedCatalogLocation

      public static final String getNamedCatalogLocation(String serverURL, String catalogName)
      Parameters:
      serverURL - the server url
      catalogName - the name of the catalog to locate
      Returns:
      String the location of a named catalog

    • getBlankNodesURL

      public static final String getBlankNodesURL(String repositoryLocation)
      Get the location of the blank nodes service for a repository
      Parameters:
      repositoryLocation - the base location of the repository
      Returns:
      the location of the blank nodes service

    • getSessionURL

      public static final String getSessionURL(String serverLocation)

    • getSessionCloseLocation

      public static final String getSessionCloseLocation(String sessionRoot)

    • getSessionPingLocation

      public static final String getSessionPingLocation(String sessionRoot)

    • getQueriesLocation

      public static final String getQueriesLocation(String sessionRoot)

    • getSavedQueryLocation

      public static final String getSavedQueryLocation(String sessionRoot, String queryName)

    • getAutoCommitLocation

      public static final String getAutoCommitLocation(String sessionRoot)

    • getStoredProcLocation

      public static final String getStoredProcLocation(String sessionRoot)

    • getStatementsDeleteLocation

      public static String getStatementsDeleteLocation(String sessionRoot)

    • getFreetextLocation

      public static String getFreetextLocation(String sessionRoot)

    • getFreetextIndexLocation

      public static String getFreetextIndexLocation(String sessionRoot)

    • getFreetextIndexLocation

      public static String getFreetextIndexLocation(String sessionRoot, String name)

    • getMappingLocation

      public static String getMappingLocation(String sessionRoot)

    • getDatatypeMappingLocation

      public static String getDatatypeMappingLocation(String sessionRoot)

    • getPredicateMappingLocation

      public static String getPredicateMappingLocation(String sessionRoot)

    • getFunctorLocation

      public static String getFunctorLocation(String serverRoot)

    • getNamedCatalogRepositoriesLocation

      public static String getNamedCatalogRepositoriesLocation(String catalogURL)

    • getRootCatalogRepositoriesLocation

      public static String getRootCatalogRepositoriesLocation(String catalogURL)

    • getEvalLocation

      public static String getEvalLocation(String sessionRoot)

    • getGeoLocation

      public static String getGeoLocation(String sessionRoot)

    • getGeoTypesLocation

      public static String getGeoTypesLocation(String sessionRoot)

    • getGeoTypesCartesianLocation

      public static String getGeoTypesCartesianLocation(String sessionRoot)

    • getGeoTypesSphericalLocation

      public static String getGeoTypesSphericalLocation(String sessionRoot)

    • getGeoBoxLocation

      public static String getGeoBoxLocation(String sessionRoot)

    • getGeoCircleLocation

      public static String getGeoCircleLocation(String sessionRoot)

    • getGeoHaversineLocation

      public static String getGeoHaversineLocation(String sessionRoot)

    • getGeoPolygonLocation

      public static String getGeoPolygonLocation(String sessionRoot)

    • getSNAGeneratorsLocation

      public static String getSNAGeneratorsLocation(String sessionRoot)

    • getSNAGeneratorLocation

      public static String getSNAGeneratorLocation(String sessionRoot, String generator)

    • getSNANeighborMatricesLocation

      public static String getSNANeighborMatricesLocation(String sessionRoot)

    • getSNANeighborMatrixLocation

      public static String getSNANeighborMatrixLocation(String sessionRoot, String matrix)

    • encode

      public static String encode(String s)

    • getIndicesURL

      public static String getIndicesURL(String root)

    • spinURL

      public static String spinURL(String root, String type, String uri) throws AGHttpException
      Throws:
      AGHttpException

    • getAttributeDefinitionLocation

      public static String getAttributeDefinitionLocation(String root)

    • getStaticFilterLocation

      public static String getStaticFilterLocation(String root)

    • getNDGeospatialDatatypeAutomation

      public static String getNDGeospatialDatatypeAutomation(String root)

    • getQueryOptionsLocation

      public static String getQueryOptionsLocation(String root)

    • getQueryOptionLocation

      public static String getQueryOptionLocation(String root, String name)