Package org.basex.query.func

Class ApiFunc

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Arr

org.basex.query.func.StandardFunc

org.basex.query.func.ApiFunc

Direct Known Subclasses:

RequestAddress, RequestAttribute, RequestAttributeNames, RequestContextPath, RequestCookie, RequestCookieNames, RequestHeader, RequestHeaderNames, RequestHostname, RequestMethod, RequestParameter, RequestParameterNames, RequestPath, RequestPort, RequestQuery, RequestRemoteAddress, RequestRemoteHostname, RequestRemotePort, RequestScheme, RequestSetAttribute, RequestUri, RestBaseUri, RestInit, RestUri, RestWadl, SessionAccessed, SessionClientId, SessionClose, SessionCreated, SessionDelete, SessionGet, SessionId, SessionNames, SessionsAccessed, SessionsClose, SessionsCreated, SessionsDelete, SessionSet, SessionsGet, SessionsIds, SessionsNames, SessionsSet

public abstract class ApiFunc
extends StandardFunc

Request function.

Author:

BaseX Team 2005-23, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.func.StandardFunc

definition, sc

Fields inherited from class org.basex.query.expr.Arr

exprs

Fields inherited from class org.basex.query.expr.ParseExpr

exprType, info

Constructor Summary

Constructors

Constructor	Description
ApiFunc()

Method Summary

Modifier and Type	Method	Description
javax.servlet.http.HttpServletRequest	request(QueryContext qc)	Returns the current HTTP servlet request.
RequestContext	requestContext(QueryContext qc)	Returns the current HTTP servlet request.

Methods inherited from class org.basex.query.func.StandardFunc

checkPerm, coerceFunc, compileData, copy, dataLock, defined, description, embed, equals, has, opt, optFirst, optFirst, optimize, serialize, simplifyArgs, toBaseUri, toBindings, toCollation, toContent, toContent, toData, toDate, toDBNode, toEncodingOrNull, toFunction, toFunction, toIO, toIO, toMs, toName, toNodeOrAtomItem, toOptions, toOptions, toPath, toPath, toStr, toString, toXml, toZeroStr, updating, vacuous

Methods inherited from class org.basex.query.expr.Arr

accept, allAreValues, arg, args, checkUp, compile, copyAll, count, exprSize, flatten, inline, inlineable, mayBePositional, removeEmpty, simplifyAll

Methods inherited from class org.basex.query.expr.ParseExpr

adoptType, atomValue, checkAllUp, checkNoEmpty, checkNoEmpty, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, data, ebv, info, item, iter, refineType, seqType, size, test, toArray, toArray, toAtomItem, toB64, toB64, toB64OrNull, toBin, toBin, toBoolean, toBoolean, toBooleanOrFalse, toBytes, toBytes, toDouble, toDouble, toElem, toElem, toFloat, toFunction, toItem, toItem, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumberOrNull, toQNm, toQNmOrNull, toRecord, toString, toString, toStringOrNull, toToken, toToken, toTokenOrNull, toZeroToken, value

Methods inherited from class org.basex.query.expr.Expr

arg, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, optimizePos, simplify, simplifyFor, typeCheck, uses, visitAll

Methods inherited from class org.basex.query.expr.ExprInfo

toErrorString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiFunc

public ApiFunc()

Method Detail

requestContext

public final RequestContext requestContext(QueryContext qc)
                                    throws QueryException

Returns the current HTTP servlet request.

Parameters:

qc - query context

Returns:

HTTP request

Throws:

QueryException - query exception

request

public final javax.servlet.http.HttpServletRequest request(QueryContext qc)
                                                    throws QueryException

Returns the current HTTP servlet request.

Parameters:

qc - query context

Returns:

HTTP request

Throws:

QueryException - query exception