Index (Opencast :: runtime-info 17-SNAPSHOT API)

A B C D F G H I J L O P R S T U V X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

activate(ComponentContext) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
addBodyParam(RestParameter) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Adds a body parameter to this endpoint.
addEndpoint(RestQuery, Class<?>, Produces, String, Path) - Method in class org.opencastproject.runtimeinfo.rest.RestDocData: Add an endpoint to the Rest documentation.
addEndPoint(RestEndpointData) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData: Add an endpoint to this holder and make sure the endpoints are sorted by their names.
addFormat(RestFormatData) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Adds a format for the return data for this endpoint.
addNote(String) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Adds a note for this endpoint.
addOptionalParam(RestParamData) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Adds an optional parameter for this endpoint, this would be a parameter which is passed in the query string (for GET) or encoded as part of the body otherwise (often referred to as a post or form parameter).
addPathParam(RestParamData) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Adds a path parameter for this endpoint, this would be a parameter which is passed as part of the path (e.g.
addRequiredParam(RestParamData) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Adds a required form parameter for this endpoint, this would be a parameter which is passed encoded as part of the request body (commonly referred to as a post or form parameter).
addStatus(RestResponse) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Adds a response status for this endpoint.

B

BOOLEAN - Enum constant in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type
bundleContext - Variable in class org.opencastproject.runtimeinfo.RestDocsServlet: The OSGI bundle context

C

clone() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData: Returns a copy of this RestEndpointHolderData object.
compareTo(RestEndpointData) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Compares two RestEndpointData by their names so that the list of endpoints can be sorted.

D

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.opencastproject.runtimeinfo.RestDocsServlet
duplicate() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData: Returns a copy of this RestEndpointHolderData object.

F

FILE - Enum constant in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type
findName(int) - Static method in class org.opencastproject.runtimeinfo.rest.StatusData: This will resolve a human readable name for all known status codes.
findRestAnnotation(Class<?>) - Static method in class org.opencastproject.runtimeinfo.RestDocsServlet: Try to find the RestService annotation starting at endpointClass.
FLOAT - Enum constant in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type

G

getAttribute(String) - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Get the value indexed by key in attributes.
getAttributes() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Get the attributes used for adjusting rendering of form elements related to this parameter.
getBodyParam() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the body parameter of this endpoint.
getCode() - Method in class org.opencastproject.runtimeinfo.rest.StatusData
getDefaultTemplatePath() - Method in class org.opencastproject.runtimeinfo.rest.RestDocData: Gets the path to the default template (a .xhtml file).
getDefaultValue() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Get the default value of this parameter.
getDescription() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the description of this endpoint.
getDescription() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Get the description of this parameter.
getDescription() - Method in class org.opencastproject.runtimeinfo.rest.StatusData
getEndpoints() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData: Gets the list of endpoints in this endpoint holder.
getEscapedDefaultValue() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData
getEscapedReturnTypeSchema() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData
getEscapedXmlSchema() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData
getForm() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the form for testing this endpoint in the documentation page.
getFormats() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the list of formats returned by this endpoint.
getHealth(HttpServletResponse) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
getItems() - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Returns the list of form parameters.
getMethod() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the name of HTTP method used to invoke this endpoint.
getMyInfo() - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
getName() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the name of this endpoint.
getName() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData: Gets the name of this endpoint holder.
getName() - Method in class org.opencastproject.runtimeinfo.rest.RestFormatData: Return the name of this format.
getName() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Get the name of this parameter.
getName() - Method in class org.opencastproject.runtimeinfo.rest.StatusData
getNotes() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets list of notes (i.e. extra information) of this endpoint.
getOptionalParams() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the list of optional parameters of this endpoint.
getPath() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the path for this endpoint.
getPathParams() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the list of path parameters of this endpoint.
getQueryString() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Returns the URL-encoded query string for a GET endpoint.
getRequiredParams() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the list of required parameters of this endpoint.
getReturnTypeSchema() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData
getRuntimeInfo(HttpServletRequest) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
getServiceStateAsJson(ServiceRegistration) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
getStatuses() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Gets the list of HTTP responses returned by this endpoint.
getTitle() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData: Gets the title of this endpoint holder.
getType() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Get the type of this parameter.
getUrl() - Method in class org.opencastproject.runtimeinfo.rest.RestFormatData: Return the default URL of this format.
getXmlSchema() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData
getXmlSchema() - Method in class org.opencastproject.runtimeinfo.rest.StatusData

H

HEALTH_CHECK_STATUS_FAIL - Static variable in class org.opencastproject.runtimeinfo.RuntimeInfo
HEALTH_CHECK_STATUS_PASS - Static variable in class org.opencastproject.runtimeinfo.RuntimeInfo
HEALTH_CHECK_STATUS_WARN - Static variable in class org.opencastproject.runtimeinfo.RuntimeInfo
HEALTH_CHECK_VERSION - Static variable in class org.opencastproject.runtimeinfo.RuntimeInfo
holders - Variable in class org.opencastproject.runtimeinfo.rest.RestDocData: List of RestEndpointHolderData which each stores a group of endpoints.

I

INTEGER - Enum constant in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type
isAjaxSubmit() - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Returns whether the form submission should be an ajax submission or a normal submission.
isBasic() - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Returns whether this form is for a basic endpoint which has no parameters.
isEmpty() - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Returns true if this form has no parameter in it, false if there is parameter in it.
isFileUpload() - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Returns whether the form contains a body parameter (i.e. a file upload option).
isGetMethod() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Returns whether this endpoint's HTTP method is GET
isPath() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Return whether this parameter is a path parameter.
isRequired() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Return whether this parameter is required.
isValidPath(String) - Static method in class org.opencastproject.runtimeinfo.rest.RestDocData: Validates paths: VALID: /sample , /sample/{thing} , /{my}/{path}.xml , /my/fancy_path/is/{awesome}.

J

JSON_URL - Static variable in class org.opencastproject.runtimeinfo.rest.RestFormatData: Default URL for the JSON format.

L

LONG - Enum constant in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type

O

org.opencastproject.runtimeinfo - package org.opencastproject.runtimeinfo
org.opencastproject.runtimeinfo.rest - package org.opencastproject.runtimeinfo.rest

P

PATH_PARAM_COUNTING_REGEX - Static variable in class org.opencastproject.runtimeinfo.rest.RestDocData: Regular expression used to count the number of path parameters in a path.

R

RestDocData - Class in org.opencastproject.runtimeinfo.rest: This is the document model class which holds the data about a set of rest endpoints.
RestDocData(String, String, String, String[]) - Constructor for class org.opencastproject.runtimeinfo.rest.RestDocData: Create the base data object for creating REST documentation.
RestDocsServlet - Class in org.opencastproject.runtimeinfo: A bundle activator that registers the REST documentation servlet.
RestDocsServlet() - Constructor for class org.opencastproject.runtimeinfo.RestDocsServlet
RestEndpointData - Class in org.opencastproject.runtimeinfo.rest
RestEndpointData(Class<?>, String, String, String, String) - Constructor for class org.opencastproject.runtimeinfo.rest.RestEndpointData: Create a new basic endpoint, you should use the add methods to fill in the rest of the information about the endpoint data
RestEndpointHolderData - Class in org.opencastproject.runtimeinfo.rest: Represents a group of endpoints.
RestEndpointHolderData(String, String) - Constructor for class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData
RestFormatData - Class in org.opencastproject.runtimeinfo.rest: Represents an output format for a REST endpoint.
RestFormatData(String) - Constructor for class org.opencastproject.runtimeinfo.rest.RestFormatData: Constructor that accepts a format name and finds the format's corresponding default URL and description.
RestFormData - Class in org.opencastproject.runtimeinfo.rest
RestFormData(RestEndpointData) - Constructor for class org.opencastproject.runtimeinfo.rest.RestFormData: Constructor which will auto-populate the form using the data in the endpoint, this will enable the ajax submit if it is possible to do so.
RestParamData - Class in org.opencastproject.runtimeinfo.rest: Represents a single parameter for an endpoint.
RestParamData(String, RestParamData.Type, String, String, String) - Constructor for class org.opencastproject.runtimeinfo.rest.RestParamData: Create a parameter for this endpoint, the thing you are adding it to indicates if required or optional
RestParamData(RestParameter) - Constructor for class org.opencastproject.runtimeinfo.rest.RestParamData: Convenient constructor: take a RestParameter annotation and create a RestParamData from it.
RestParamData.Type - Enum Class in org.opencastproject.runtimeinfo.rest
RuntimeInfo - Class in org.opencastproject.runtimeinfo: This REST endpoint provides information about the runtime environment, including the services and user interfaces deployed and the current login context.
RuntimeInfo() - Constructor for class org.opencastproject.runtimeinfo.RuntimeInfo

S

SERVICE_FILTER - Static variable in class org.opencastproject.runtimeinfo.RuntimeInfo: The rest publisher looks for any non-servlet with the 'opencast.service.path' property
SERVLET_PATH - Static variable in class org.opencastproject.runtimeinfo.RestDocsServlet: The servlet path
setAbstract(String) - Method in class org.opencastproject.runtimeinfo.rest.RestDocData: Creates an abstract section which is displayed at the top of the documentation page.
setAjaxSubmit(boolean) - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Controls whether the form will be submitted via ajax and the content rendered on the page, NOTE that uploading any files or downloading any content that is binary will require not using ajax submit, also note that there may be other cases where ajax submission will fail to work OR where normal submission will fail to work (using PUT/DELETE)
setAttribute(String, String) - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Attributes are used for adjusting rendering of form elements related to this parameter.
setFileUpload(boolean) - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Set this to true if the file contains a file upload control, this will be determined automatically for auto-generated forms.
setPath(boolean) - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Set whether this parameter is a path parameter.
setRequired(boolean) - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Set whether this parameter is required.
setSecurityService(SecurityService) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
setServiceRegistry(ServiceRegistry) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
setTestForm(RestFormData) - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Sets the test form for this endpoint, if this is null then no test form is rendered for this endpoint.
setUserIdRoleProvider(UserIdRoleProvider) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo
setXmlSchema(String) - Method in class org.opencastproject.runtimeinfo.rest.RestParamData
setXmlSchema(String) - Method in class org.opencastproject.runtimeinfo.rest.StatusData
start(BundleContext) - Method in class org.opencastproject.runtimeinfo.RestDocsServlet
StatusData - Class in org.opencastproject.runtimeinfo.rest: Represents a possible status result for an endpoint
StatusData(int, String) - Constructor for class org.opencastproject.runtimeinfo.rest.StatusData: A constructor that takes a HTTP response code and a description for this response and constructs a StatusData object.
StatusData(int, String, String) - Constructor for class org.opencastproject.runtimeinfo.rest.StatusData: A constructor that takes a HTTP response code and a description for this response, and an XML schema for the response and constructs a StatusData object.
StatusData(RestResponse) - Constructor for class org.opencastproject.runtimeinfo.rest.StatusData: A constructor that takes a RestResponse annotation type object and constructs a StatusData object.
stop(BundleContext) - Method in class org.opencastproject.runtimeinfo.RestDocsServlet
STRING - Enum constant in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type

T

TEXT - Enum constant in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type
toMap() - Method in class org.opencastproject.runtimeinfo.rest.RestDocData: Verify the integrity of this object.
toString() - Method in class org.opencastproject.runtimeinfo.rest.RestDocData: Returns a string representation of this object.
toString() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointData: Returns a string representation of this object.
toString() - Method in class org.opencastproject.runtimeinfo.rest.RestEndpointHolderData: Return a string representation of this RestEndpointHolderData object.
toString() - Method in class org.opencastproject.runtimeinfo.rest.RestFormatData: Return a string representation of this object.
toString() - Method in class org.opencastproject.runtimeinfo.rest.RestFormData: Returns a string representation of this form.
toString() - Method in class org.opencastproject.runtimeinfo.rest.RestParamData: Return a string representation of this RestParamData object.
toString() - Method in class org.opencastproject.runtimeinfo.rest.StatusData

U

unsetUserIdRoleProvider(UserIdRoleProvider) - Method in class org.opencastproject.runtimeinfo.RuntimeInfo

V

valueOf(String) - Static method in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.opencastproject.runtimeinfo.rest.RestParamData.Type: Returns an array containing the constants of this enum class, in the order they are declared.

X

XML_URL - Static variable in class org.opencastproject.runtimeinfo.rest.RestFormatData: Default URL for the XML format.

A B C D F G H I J L O P R S T U V X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form