Index

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

A

action() - Static method in class org.forgerock.api.models.Action

Creates a new builder for Action.

action(Action) - Method in class org.forgerock.api.models.Items.Builder

Adds one Action to the list of Actions.

action(Action) - Method in class org.forgerock.api.models.Resource.Builder

Adds one Action to the list of Actions.

Action - Class in org.forgerock.api.models

Class that represents the Action operation type in API descriptor.

Action - Annotation Type in org.forgerock.api.annotations

Indicates an CREST action method on an annotated POJO.

Action.Builder - Class in org.forgerock.api.models

Builder class for creating the Action.

actions(List<Action>) - Method in class org.forgerock.api.models.Items.Builder

Set Actions.

actions(List<Action>) - Method in class org.forgerock.api.models.Resource.Builder

Set Actions.

Actions - Annotation Type in org.forgerock.api.annotations

Declare an array of Action operations from a single method.

ADD - Enum constant in enum org.forgerock.api.enums.PatchOperation

Adds a field.

addApiInfo(ApiDescription) - Method in class org.forgerock.api.CrestApiProducer

addHeaderToAllOperations(HeaderParameter, Swagger) - Static method in class org.forgerock.api.transform.OpenApiHelper

Adds a header to all operations.

ADDITIONAL - Enum constant in enum org.forgerock.api.enums.ParameterSource

Parameter comes from the request.

AdditionalProperties - Annotation Type in org.forgerock.api.annotations

Annotation to define JSON Schema additionalProperties, which is useful when working with key/value JSON data structures.

addTag(String) - Method in class org.forgerock.api.transform.LocalizableOperation

addTag(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableOperation

Adds a Tag, a String value that is metadata related to the Operation.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Action

Allocates the Action operation type to the given Resource Builder.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Create

Allocates the Create operation type to the given Resource Builder.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Delete

Allocates the Delete operation type to the given Resource Builder.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Operation

Allocates the operation by operation type to the given Resource Builder by calling the corresonding method by type.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Patch

Allocates the Patch operation type to the given Resource Builder.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Query

Allocates the Query operation type to the given Resource Builder.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Read

Allocates the Read operation type to the given Resource Builder.

allocateToResource(Resource.Builder) - Method in class org.forgerock.api.models.Update

Allocates the Update operation type to the given Resource Builder.

anchor(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a cross-reference anchor.

anchor(String, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a cross-reference anchor, with a custom xreflabel.

ANCHOR_END - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Cross-reference anchor end.

ANCHOR_START - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Cross-reference anchor start.

anySchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory

apiDescription() - Static method in class org.forgerock.api.models.ApiDescription

Create a new Builder for ApiDescription.

ApiDescription - Class in org.forgerock.api.models

Class that represents the ApiDescription type in API descriptor.

ApiDescription.Builder - Class in org.forgerock.api.models

Builder for the ApiDescription.

ApiDocGenerator - Class in org.forgerock.api.markup

Generates static AsciiDoc documentation for CREST API Descriptors.

ApiDocGeneratorException - Exception in org.forgerock.api.markup

Signals that an error occurred while generating API documentation.

ApiDocGeneratorException(String) - Constructor for exception org.forgerock.api.markup.ApiDocGeneratorException

Creates a ApiDocGeneratorException with a detailed error message.

ApiDocGeneratorException(String, Throwable) - Constructor for exception org.forgerock.api.markup.ApiDocGeneratorException

Creates a ApiDocGeneratorException with a detailed error message and cause.

apiError() - Static method in class org.forgerock.api.models.ApiError

New apiError builder.

ApiError - Class in org.forgerock.api.models

Class that represents the ApiError type in API descriptor.

ApiError - Annotation Type in org.forgerock.api.annotations

Details of an error that could be returned.

ApiError.Builder - Class in org.forgerock.api.models

Builder for the ApiError.

ApiValidationException - Exception in org.forgerock.api

Signals that API failed validation.

ApiValidationException(String) - Constructor for exception org.forgerock.api.ApiValidationException

Creates a ApiValidationException with a detailed error message.

apply(JsonValue) - Method in class org.forgerock.api.models.TranslateJsonSchema

Applies the translation to string values by converting them to LocalizableString.

arraySchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory

ASCII_DOC_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Block-level elements (paragraphs, delimited blocks and block macros) AsciiDoc content.

asciiDoc() - Static method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Creates a new builder instance.

AsciiDoc - Class in org.forgerock.api.markup.asciidoc

Root builder for AsciiDoc markup.

AsciiDocException - Exception in org.forgerock.api.markup.asciidoc

Signals that an error occurred while building AsciiDoc markup.

AsciiDocException(String) - Constructor for exception org.forgerock.api.markup.asciidoc.AsciiDocException

Creates a AsciiDocException with a detailed error message.

AsciiDocSymbols - Enum in org.forgerock.api.markup.asciidoc

Enumeration of AsciiDoc markup symbols.

AsciiDocTable - Class in org.forgerock.api.markup.asciidoc

AsciiDoc table builder [ref], which defers insertion of the table, at the end of the parent document, until AsciiDocTable.tableEnd() is called.

AsciiDocTableColumnStyles - Enum in org.forgerock.api.markup.asciidoc

AsciiDoc table column-styles.

asResource(boolean, Schema, LocalizableString, LocalizableString) - Method in class org.forgerock.api.models.Items

Builds a Resource from this Items instance.

B

BAD_GATEWAY - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "bad gateway" error.

BAD_GATEWAY_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.BAD_GATEWAY in an API Description.

BAD_REQUEST - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "bad request" error.

BAD_REQUEST_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.BAD_REQUEST in an API Description.

BigDecimalUtil - Class in org.forgerock.api.util

Common utility methods for dealing with BigDecimal values.

BLOCK_TITLE - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Block title.

blockTitle(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a block title.

BOLD - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Bold text.

boldText(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts bold text.

booleanSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory

build() - Method in class org.forgerock.api.models.Action.Builder

Builds the Action instance.

build() - Method in class org.forgerock.api.models.ApiDescription.Builder

Builds the ApiDescription instance.

build() - Method in class org.forgerock.api.models.ApiError.Builder

Builds the ApiError.

build() - Method in class org.forgerock.api.models.Create.Builder

Builds the Create instance.

build() - Method in class org.forgerock.api.models.Definitions.Builder

Builds the Definitions instance.

build() - Method in class org.forgerock.api.models.Delete.Builder

Builds the Delete instance.

build() - Method in class org.forgerock.api.models.Errors.Builder

Builds the Errors instance.

build() - Method in class org.forgerock.api.models.Items.Builder

Construct a new instance of Resource.

build() - Method in class org.forgerock.api.models.Parameter.Builder

Builds the Parameter.

build() - Method in class org.forgerock.api.models.Patch.Builder

Builds the Patch instance.

build() - Method in class org.forgerock.api.models.Paths.Builder

Builds the Paths instance.

build() - Method in class org.forgerock.api.models.Query.Builder

Builds the Query instance.

build() - Method in class org.forgerock.api.models.Read.Builder

Builds the Create instance.

build() - Method in class org.forgerock.api.models.Reference.Builder

Builds the Reference instance.

build() - Method in class org.forgerock.api.models.Resource.Builder

Construct a new instance of Resource.

build() - Method in class org.forgerock.api.models.Schema.Builder

Builds the Schema instance.

build() - Method in class org.forgerock.api.models.Services.Builder

Builds the Definitions instance.

build() - Method in class org.forgerock.api.models.SubResources.Builder

Builds the SubResources instance.

build() - Method in class org.forgerock.api.models.Update.Builder

Builds the Create instance.

build() - Method in class org.forgerock.api.models.VersionedPath.Builder

Builds the VersionedPath instance.

Builder() - Constructor for class org.forgerock.api.models.Action.Builder

Builder() - Constructor for class org.forgerock.api.models.Items.Builder

Private default constructor.

Builder() - Constructor for class org.forgerock.api.models.Operation.Builder

Creates a new Builder.

Builder() - Constructor for class org.forgerock.api.models.Query.Builder

Builder() - Constructor for class org.forgerock.api.models.Read.Builder

Builder() - Constructor for class org.forgerock.api.models.Resource.Builder

Private default constructor.

buildPath(String, String...) - Static method in class org.forgerock.api.util.PathUtil

Builds a forward-slash-delimited path, with duplicate forward-slashes removed, and trailing slashes removed.

buildPathParameters(String) - Static method in class org.forgerock.api.util.PathUtil

Searches for curly-braces in the given pathSegment, and creates a path-parameter for each that are found.

C

CLIENT - Enum constant in enum org.forgerock.api.enums.ReadPolicy

Property is hidden from user-interface, but readable via client APIs.

code() - Element in annotation type org.forgerock.api.annotations.ApiError

The error code that will be returned in this situation.

code(Integer) - Method in class org.forgerock.api.models.ApiError.Builder

Set the error code.

COLLECTION_RESOURCE_COLLECTION - Enum constant in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant

A collection resource handler, collection endpoint (expect CAQ opererations).

COLLECTION_RESOURCE_INSTANCE - Enum constant in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant

A collection resource handler, instance endpoint (expect CRUDPA operations).

CollectionProvider - Annotation Type in org.forgerock.api.annotations

A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST collection provider resource.

COLUMN_WIDTH_MEDIUM - Static variable in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Medium column-width (2x AsciiDocTable.COLUMN_WIDTH_SMALL) for use with AsciiDocTable.columnWidths(int...).

COLUMN_WIDTH_SMALL - Static variable in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Small column-width for use with AsciiDocTable.columnWidths(int...).

columnCell(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Inserts a column-cell.

columnCell(String, AsciiDocTableColumnStyles) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Inserts a column-cell, with a style.

columnsPerRow(int) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Sets number of columns per row, which is implicitly set by AsciiDocTable.headers(String...) and AsciiDocTable.columnWidths(int...).

columnWidths(int...) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Sets the widths for all columns-per-row, which can be a proportional integer (the default is 1) or a percentage (1 to 99).

columnWidths(List<Integer>) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Sets the widths for all columns-per-row, which can be a proportional integer (the default is 1) or a percentage (1 to 99).

COMMONS_API_DESCRIPTION - Static variable in class org.forgerock.api.commons.CommonsApi

The api description of "frapi:common" which only contains errors so far.

CommonsApi - Class in org.forgerock.api.commons

Commons ForgeRock API description.

CommonsApi.Errors - Enum in org.forgerock.api.commons

Common api errors.

compareTo(Action) - Method in class org.forgerock.api.models.Action

Compares two strings lexicographically.

compareTo(Query) - Method in class org.forgerock.api.models.Query

Compares two queries.

CONFLICT - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "conflict" error.

CONFLICT_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.CONFLICT in an API Description.

containsWhitespace(String) - Static method in class org.forgerock.api.util.ValidationUtil

Checks a String for whitespace.

COOKIE - Enum constant in enum org.forgerock.api.enums.PagingMode

Paging mode is supported by cookies.

COPY - Enum constant in enum org.forgerock.api.enums.PatchOperation

Copies a field.

countPolicies() - Element in annotation type org.forgerock.api.annotations.Query

The count policies that can be used with this query.

countPolicies(CountPolicy...) - Method in class org.forgerock.api.models.Query.Builder

Set the supported page count policies.

CountPolicy - Enum in org.forgerock.api.enums

Enum that represents the Query supported count-policy.

create() - Static method in class org.forgerock.api.models.Create

Creates a new builder for Create.

create(Create) - Method in class org.forgerock.api.models.Items.Builder

Set create.

create(Create) - Method in class org.forgerock.api.models.Resource.Builder

Set create.

Create - Class in org.forgerock.api.models

Class that represents the Create Operation type in API descriptor.

Create - Annotation Type in org.forgerock.api.annotations

Indicates an CREST create method on an annotated POJO.

Create.Builder - Class in org.forgerock.api.models

Builder for the Create.

createGenericMapper() - Static method in class org.forgerock.api.jackson.JacksonUtils

Create a Jackson JSON object mapper that is best-suited for general-purpose use by documentation and tests.

CreateMode - Enum in org.forgerock.api.enums

Enum that represents the Create modes.

CreateSingleton - Enum in org.forgerock.api.enums

Types of create that might be singletons.

CrestAnySchema - Class in org.forgerock.api.jackson

An extension to the Jackson AnySchema that includes the custom CREST JSON Schema attributes.

CrestAnySchema() - Constructor for class org.forgerock.api.jackson.CrestAnySchema

CrestApiProducer - Class in org.forgerock.api

An ApiProducer implementation for CREST resources, that provides ApiDescription descriptors.

CrestApiProducer(String, String) - Constructor for class org.forgerock.api.CrestApiProducer

Construct a new producer.

CrestApiProducer(String, String, LocalizableString) - Constructor for class org.forgerock.api.CrestApiProducer

Construct a new producer.

CrestArraySchema - Class in org.forgerock.api.jackson

An extension to the Jackson ArraySchema that includes the custom CREST JSON Schema attributes.

CrestArraySchema() - Constructor for class org.forgerock.api.jackson.CrestArraySchema

CrestBooleanSchema - Class in org.forgerock.api.jackson

An extension to the Jackson BooleanSchema that includes the custom CREST JSON Schema attributes.

CrestBooleanSchema() - Constructor for class org.forgerock.api.jackson.CrestBooleanSchema

CrestJsonSchemaFactory - Class in org.forgerock.api.jackson

A JsonSchemaFactory that returns the extension schema objects rather than the default Jackson implementations.

CrestJsonSchemaFactory() - Constructor for class org.forgerock.api.jackson.CrestJsonSchemaFactory

CrestObjectSchema - Class in org.forgerock.api.jackson

An extension to the Jackson ObjectSchema that includes the custom CREST JSON Schema attributes.

CrestObjectSchema() - Constructor for class org.forgerock.api.jackson.CrestObjectSchema

CrestPropertyDetailsSchemaFactoryWrapper - Class in org.forgerock.api.jackson

A SchemaFactoryWrapper that adds the extra CREST schema attributes once the Jackson schema generation has been completed.

CrestPropertyDetailsSchemaFactoryWrapper() - Constructor for class org.forgerock.api.jackson.CrestPropertyDetailsSchemaFactoryWrapper

Create a new wrapper.

CROSS_REF_END - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Cross-reference end.

CROSS_REF_START - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Cross-reference start.

D

Default - Annotation Type in org.forgerock.api.annotations

Annotation to define JSON Schema property's default-value, represented as a String.

DEFAULT_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

No additional styles (default).

defaultValue() - Element in annotation type org.forgerock.api.annotations.Parameter

The default value, if applicable.

defaultValue(String) - Method in class org.forgerock.api.models.Parameter.Builder

Set the parameter default value.

definitions() - Static method in class org.forgerock.api.models.Definitions

Create a new Builder for Definitions.

definitions(Definitions) - Method in class org.forgerock.api.models.ApiDescription.Builder

Set the definitions.

Definitions - Class in org.forgerock.api.models

Class that represents API descriptor Schema definitions.

Definitions.Builder - Class in org.forgerock.api.models

Builder to help construct the Definitions.

delete() - Static method in class org.forgerock.api.models.Delete

Creates a new builder for Delete.

delete(Delete) - Method in class org.forgerock.api.models.Items.Builder

Set Delete.

delete(Delete) - Method in class org.forgerock.api.models.Resource.Builder

Set Delete.

Delete - Class in org.forgerock.api.models

Class that represents the Delete operation type in API descriptor.

Delete - Annotation Type in org.forgerock.api.annotations

Indicates an CREST delete method on an annotated POJO.

Delete.Builder - Class in org.forgerock.api.models

Builder for the Delete.

DEPRECATED - Enum constant in enum org.forgerock.api.enums.Stability

Deprecated API, that should not be used and may be removed in the future.

description() - Element in annotation type org.forgerock.api.annotations.ApiError

A description of the error condition, and what may have caused it.

description() - Element in annotation type org.forgerock.api.annotations.Handler

Service description, for documentation purposes.

description() - Element in annotation type org.forgerock.api.annotations.Operation

A description of the operation.

description() - Element in annotation type org.forgerock.api.annotations.Parameter

A description of the parameter.

description(String) - Method in class org.forgerock.api.models.ApiDescription.Builder

Sets the description.

description(String) - Method in class org.forgerock.api.models.ApiError.Builder

Set the error description.

description(String) - Method in class org.forgerock.api.models.Operation.Builder

Set the description.

description(String) - Method in class org.forgerock.api.models.Parameter.Builder

Set the parameter description.

description(String) - Method in class org.forgerock.api.models.Resource.Builder

Set the description.

description(String) - Method in class org.forgerock.api.transform.LocalizableOperation

description(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty

description(String) - Method in class org.forgerock.api.transform.LocalizableTag

description(LocalizableString) - Method in class org.forgerock.api.models.ApiDescription.Builder

Sets the description.

description(LocalizableString) - Method in class org.forgerock.api.models.ApiError.Builder

Set the error description.

description(LocalizableString) - Method in class org.forgerock.api.models.Operation.Builder

Set the description.

description(LocalizableString) - Method in class org.forgerock.api.models.Parameter.Builder

Set the parameter description.

description(LocalizableString) - Method in class org.forgerock.api.models.Resource.Builder

Set the description.

description(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableOperation

description(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableRefProperty

description(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableTag

Description - Annotation Type in org.forgerock.api.annotations

Annotation to define JSON Schema property's description.

details() - Element in annotation type org.forgerock.api.annotations.CollectionProvider

The details of the handler.

detailSchema() - Element in annotation type org.forgerock.api.annotations.ApiError

The schema for the error detail, if relevant.

detailsFromAnnotation(Operation, ApiDescription, Class<?>) - Method in class org.forgerock.api.models.Operation.Builder

Set all properties in the Builder using the data in the annotation.

DOC_TITLE - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Document title.

documentTitle(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a document title.

E

EMPHASIS_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Italic text.

EnumTitle - Annotation Type in org.forgerock.api.annotations

Annotation to provide a title for a given enum value.

enumTitles() - Element in annotation type org.forgerock.api.annotations.Parameter

Titles of enumeration values.

enumTitles(String...) - Method in class org.forgerock.api.models.Parameter.Builder

Sets enum-titles that must be the same length as Parameter.Builder.enumValues(String[]), if provided.

enumValues() - Element in annotation type org.forgerock.api.annotations.Parameter

Enumeration of acceptable values, if required.

enumValues(String...) - Method in class org.forgerock.api.models.Parameter.Builder

Sets enum-values that must match.

equals(Object) - Method in class org.forgerock.api.models.Action

equals(Object) - Method in class org.forgerock.api.models.ApiDescription

equals(Object) - Method in class org.forgerock.api.models.ApiError

equals(Object) - Method in class org.forgerock.api.models.Create

equals(Object) - Method in class org.forgerock.api.models.Definitions

equals(Object) - Method in class org.forgerock.api.models.Errors

equals(Object) - Method in class org.forgerock.api.models.Items

equals(Object) - Method in class org.forgerock.api.models.Operation

equals(Object) - Method in class org.forgerock.api.models.Parameter

equals(Object) - Method in class org.forgerock.api.models.Patch

equals(Object) - Method in class org.forgerock.api.models.Paths

equals(Object) - Method in class org.forgerock.api.models.Query

equals(Object) - Method in class org.forgerock.api.models.Reference

equals(Object) - Method in class org.forgerock.api.models.Resource

equals(Object) - Method in class org.forgerock.api.models.Schema

equals(Object) - Method in class org.forgerock.api.models.Services

equals(Object) - Method in class org.forgerock.api.models.SubResources

equals(Object) - Method in class org.forgerock.api.models.VersionedPath

error(ApiError) - Method in class org.forgerock.api.models.Operation.Builder

Sets a single supported error.

ERROR_COMPARATOR - Static variable in class org.forgerock.api.models.ApiError

ApiError Comparator, which sorts by code and description.

ERROR_ENTRY_COMPARATOR - Static variable in class org.forgerock.api.models.Errors

ApiError Map-entry Comparator, which sorts by code and description.

errorOnWritePolicyFailure() - Element in annotation type org.forgerock.api.annotations.PropertyPolicies

Whether breaking the declared policy will result in an error from the service.

errorRefs() - Element in annotation type org.forgerock.api.annotations.Operation

JSON references to previously declared errors (e.g., frapi:common#/errors/badRequest).

errors() - Element in annotation type org.forgerock.api.annotations.Operation

Operation specific error definitions.

errors() - Static method in class org.forgerock.api.models.Errors

Create a new Builder for Errors.

errors(List<ApiError>) - Method in class org.forgerock.api.models.Operation.Builder

Set multiple supported errors.

errors(Errors) - Method in class org.forgerock.api.models.ApiDescription.Builder

Set the errors.

Errors - Class in org.forgerock.api.models

Class that represents API descriptor ApiError errors.

Errors.Builder - Class in org.forgerock.api.models

Builder to help construct the Errors.

ESTIMATE - Enum constant in enum org.forgerock.api.enums.CountPolicy

Estimate count policy is supported.

EVOLVING - Enum constant in enum org.forgerock.api.enums.Stability

Evolving API that may changed at any time.

EXACT - Enum constant in enum org.forgerock.api.enums.CountPolicy

Exact count policy is supported.

Example - Annotation Type in org.forgerock.api.annotations

Specify an example value for the JSON schema.

EXAMPLE - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Example block.

exampleBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts an example-block.

execute(String, ApiDescription, Path, Path, ApiDescription...) - Static method in class org.forgerock.api.markup.ApiDocGenerator

Generates AsciiDoc documentation for a CREST API Descriptor, to an output-directory.

execute(String, ApiDescription, Path, ApiDescription...) - Static method in class org.forgerock.api.markup.ApiDocGenerator

Generates AsciiDoc documentation for a CREST API Descriptor, to a String.

execute(ApiDescription, ApiDescription...) - Static method in class org.forgerock.api.transform.OpenApiTransformer

Transforms an ApiDescription into a Swagger model.

execute(LocalizableString, String, String, boolean, ApiDescription, ApiDescription...) - Static method in class org.forgerock.api.transform.OpenApiTransformer

Transforms an ApiDescription into a Swagger model.

EXPECTATION_FAILED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "expectation failed" error.

EXPECTATION_FAILED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.EXPECTATION_FAILED in an API Description.

expectObjectFormat(JavaType) - Method in class org.forgerock.api.jackson.CrestPropertyDetailsSchemaFactoryWrapper

EXPRESSION - Enum constant in enum org.forgerock.api.enums.QueryType

Query by using expression.

F

FALSE - Enum constant in enum org.forgerock.api.enums.CreateSingleton

The created resource is not a singleton.

FILTER - Enum constant in enum org.forgerock.api.enums.QueryType

Query by using filter.

FORBIDDEN - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "forbidden" error.

FORBIDDEN_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.FORBIDDEN in an API Description.

Format - Annotation Type in org.forgerock.api.annotations

Annotation to mark a JSON Schema property's format field.

FROM_CONTEXT - Enum constant in enum org.forgerock.api.enums.CreateSingleton

Derive the singleton from the usage context.

fromAnnotatedType(Class<?>, ApiDescription, SubResources) - Static method in class org.forgerock.api.models.Items

Build an Items from an annotated request handler.

fromAnnotatedType(Class<?>, Resource.AnnotatedTypeVariant, ApiDescription) - Static method in class org.forgerock.api.models.Resource

Build a Resource from an annotated request handler.

fromAnnotatedType(Class<?>, Resource.AnnotatedTypeVariant, Items, ApiDescription, Parameter...) - Static method in class org.forgerock.api.models.Resource

Build a Resource from an annotated request handler.

fromAnnotatedType(Class<?>, Resource.AnnotatedTypeVariant, SubResources, ApiDescription, Parameter...) - Static method in class org.forgerock.api.models.Resource

Build a Resource from an annotated request handler.

fromAnnotation(Class<?>, Parameter) - Static method in class org.forgerock.api.models.Parameter

Builds a Parameter object from the data in the annotation.

fromAnnotation(Action, Method, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Action

Builds an Action object using the data in the annotation.

fromAnnotation(ApiError, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.ApiError

Builds an ApiError object from the data in the annotation.

fromAnnotation(Create, boolean, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Create

Builds a Create object from the data in the annotation.

fromAnnotation(Delete, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Delete

Builds a Delete object from the data in the Delete annotation.

fromAnnotation(Patch, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Patch

Builds a Patch object from the data stored in the annotation.

fromAnnotation(Query, Method, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Query

Builds a Query object from the data stored in the annotation.

fromAnnotation(Read, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Read

Builds a Read object from the data in the read annotation.

fromAnnotation(Schema, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Schema

Builds Schema object from the data in the annotation parameter.

fromAnnotation(Update, ApiDescription, Class<?>) - Static method in class org.forgerock.api.models.Update

Builds an Update object from the data stored in the annotation.

fromType() - Element in annotation type org.forgerock.api.annotations.Schema

The type to produce the schema from.

G

GATEWAY_TIMEOUT - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "gateway timeout" error.

GATEWAY_TIMEOUT_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.GATEWAY_TIMEOUT in an API Description.

get(String) - Method in class org.forgerock.api.models.Definitions

Gets the Schema for a given Schema-name.

get(String) - Method in class org.forgerock.api.models.Errors

Gets the ApiError for a given ApiError-name.

get(String) - Method in class org.forgerock.api.models.Paths

Gets the Path for a given Path-name.

get(String) - Method in class org.forgerock.api.models.Services

Gets the Resource for a given service-name.

get(String) - Method in class org.forgerock.api.models.SubResources

Gets the Resource for a given sub-resource name.

get(Version) - Method in class org.forgerock.api.models.VersionedPath

Gets the Resource for a given version.

getActions() - Method in class org.forgerock.api.models.Items

Getter of actions.

getActions() - Method in class org.forgerock.api.models.Resource

Getter of actions.

getApiErrors() - Method in class org.forgerock.api.models.Operation

Getter of the error array.

getCode() - Method in class org.forgerock.api.models.ApiError

Getter of the error code.

getCountPolicies() - Method in class org.forgerock.api.models.Query

Getter of the supported paging policies.

getCreate() - Method in class org.forgerock.api.models.Items

Getter of Create.

getCreate() - Method in class org.forgerock.api.models.Resource

Getter of Create.

getDefaultValue() - Method in class org.forgerock.api.models.Parameter

Getter of the parameter's default value.

getDefinition(Reference) - Method in class org.forgerock.api.util.ReferenceResolver

Gets a Definitions Schema by JSON reference.

getDefinitions() - Method in class org.forgerock.api.models.ApiDescription

Getter of definitions.

getDefinitions() - Method in class org.forgerock.api.models.Definitions

Gets a Map of schema-names to Schemas.

getDelete() - Method in class org.forgerock.api.models.Items

Getter of Delete.

getDelete() - Method in class org.forgerock.api.models.Resource

Getter of Delete.

getDescription() - Method in class org.forgerock.api.models.ApiDescription

Gets description of API Descriptor.

getDescription() - Method in class org.forgerock.api.models.ApiError

Getter of the error description.

getDescription() - Method in class org.forgerock.api.models.Operation

Getter of the description.

getDescription() - Method in class org.forgerock.api.models.Parameter

Getter of the parameter description.

getDescription() - Method in class org.forgerock.api.models.Resource

Getter of description.

getDescription() - Method in class org.forgerock.api.transform.LocalizableRefProperty

getEnumTitles() - Method in class org.forgerock.api.models.Parameter

Getter of enum-titles.

getEnumValues() - Method in class org.forgerock.api.models.Parameter

Getter of required enum-values.

getError(Reference) - Method in class org.forgerock.api.util.ReferenceResolver

Gets and Errors ApiError by JSON reference.

getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestAnySchema

getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestArraySchema

getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestBooleanSchema

getErrorOnWritePolicyFailure() - Method in class org.forgerock.api.jackson.CrestObjectSchema

getErrors() - Method in class org.forgerock.api.models.ApiDescription

Getter of errors.

getErrors() - Method in class org.forgerock.api.models.Errors

Gets a Map of error-names to ApiErrors.

getExample() - Method in class org.forgerock.api.jackson.CrestAnySchema

getExample() - Method in class org.forgerock.api.jackson.CrestArraySchema

getExample() - Method in class org.forgerock.api.jackson.CrestBooleanSchema

getExample() - Method in class org.forgerock.api.jackson.CrestObjectSchema

getExample() - Method in interface org.forgerock.api.jackson.WithExampleSchema

Gets example JSON Schema field.

getId() - Method in class org.forgerock.api.models.ApiDescription

Getter of id.

getItems() - Method in class org.forgerock.api.models.Resource

Getter of items.

getLocalizableDescription() - Method in class org.forgerock.api.transform.LocalizableOperation

getLocalizableDescription() - Method in class org.forgerock.api.transform.LocalizableRefProperty

getLocalizableDescription() - Method in class org.forgerock.api.transform.LocalizableTag

getLocalizableName() - Method in class org.forgerock.api.transform.LocalizableTag

Returns the name of a Tag, a LocalizableString.

getLocalizableTags() - Method in class org.forgerock.api.transform.LocalizableOperation

Returns the localizable tags for this operation.

getLocalizableTitle() - Method in class org.forgerock.api.transform.LocalizableRefProperty

getMode() - Method in class org.forgerock.api.models.Create

Getter of the mode.

getMultipleOf() - Method in interface org.forgerock.api.jackson.MultipleOfSchema

Gets multipleOf JSON Schema field.

getName() - Method in class org.forgerock.api.models.Action

Getter of the ID.

getName() - Method in class org.forgerock.api.models.Parameter

Getter of the name of the parameter.

getName() - Method in class org.forgerock.api.transform.LocalizableTag

getNames() - Method in class org.forgerock.api.models.Definitions

Returns all Schema names.

getNames() - Method in class org.forgerock.api.models.Errors

Returns all ApiError names.

getNames() - Method in class org.forgerock.api.models.Paths

Returns all Path names.

getNames() - Method in class org.forgerock.api.models.Services

Returns all Services names.

getNames() - Method in class org.forgerock.api.models.SubResources

Returns all sub-resource names.

getOperations() - Method in class org.forgerock.api.models.Patch

Getter for supported Patch operations.

getPagingModes() - Method in class org.forgerock.api.models.Query

Getter of the paging modes.

getParameters() - Method in class org.forgerock.api.models.Operation

Getter of the parameters array.

getParameters() - Method in class org.forgerock.api.models.Resource

Getter of the parameters array.

getPatch() - Method in class org.forgerock.api.models.Items

Getter of Patch.

getPatch() - Method in class org.forgerock.api.models.Resource

Getter of Patch.

getPathParameter() - Method in class org.forgerock.api.models.Items

Get the path parameter.

getPaths() - Method in class org.forgerock.api.models.ApiDescription

Getter of paths.

getPaths() - Method in class org.forgerock.api.models.Paths

Gets a Map of path-names to Paths.

getPaths() - Method in class org.forgerock.api.models.VersionedPath

Gets a Map of versions to Resources.

getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestAnySchema

getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestArraySchema

getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestBooleanSchema

getPropertyOrder() - Method in class org.forgerock.api.jackson.CrestObjectSchema

getQueries() - Method in class org.forgerock.api.models.Resource

Getter of queries.

getQueryableFields() - Method in class org.forgerock.api.models.Query

Getter of the queryable fields.

getQueryId() - Method in class org.forgerock.api.models.Query

Getter of the query id.

getRead() - Method in class org.forgerock.api.models.Items

Getter of Read.

getRead() - Method in class org.forgerock.api.models.Resource

Getter of Read.

getReadonly() - Method in class org.forgerock.api.jackson.CrestBooleanSchema

Gets read-only property.

getReadonly() - Method in class org.forgerock.api.jackson.CrestObjectSchema

Gets read-only property.

getReadPolicy() - Method in class org.forgerock.api.jackson.CrestAnySchema

getReadPolicy() - Method in class org.forgerock.api.jackson.CrestArraySchema

getReadPolicy() - Method in class org.forgerock.api.jackson.CrestBooleanSchema

getReadPolicy() - Method in class org.forgerock.api.jackson.CrestObjectSchema

getReference() - Method in enum org.forgerock.api.commons.CommonsApi.Errors

The reference to use in an API description.

getReference() - Method in class org.forgerock.api.models.ApiError

Getter of the reference.

getReference() - Method in class org.forgerock.api.models.Resource

Gets the reference.

getReference() - Method in class org.forgerock.api.models.Schema

Getter for reference.

getRequest() - Method in class org.forgerock.api.models.Action

Getter of the request.

getRequiredFields() - Method in class org.forgerock.api.jackson.CrestObjectSchema

getResourceSchema() - Method in class org.forgerock.api.models.Resource

Getter of resource schema.

getResponse() - Method in class org.forgerock.api.models.Action

Getter of the response.

getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestAnySchema

getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestArraySchema

getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestBooleanSchema

getReturnOnDemand() - Method in class org.forgerock.api.jackson.CrestObjectSchema

getSchema() - Method in class org.forgerock.api.models.ApiError

Getter of the error schema.

getSchema() - Method in class org.forgerock.api.models.Schema

Obtain the schema definition if it is not a reference.

getService(Reference) - Method in class org.forgerock.api.util.ReferenceResolver

Get a Services Resource by JSON reference.

getServices() - Method in class org.forgerock.api.models.ApiDescription

Getter of services.

getServices() - Method in class org.forgerock.api.models.Services

Gets a Map of service-names to Resources.

getSource() - Method in class org.forgerock.api.models.Parameter

Getter of the parameter source.

getStability() - Method in class org.forgerock.api.models.Operation

Getter of Operation stability.

getSubresources() - Method in class org.forgerock.api.models.Items

Getter of sub-resources.

getSubresources() - Method in class org.forgerock.api.models.Resource

Getter of sub-resources.

getSubResources() - Method in class org.forgerock.api.models.SubResources

Gets a Map of paths to Resources.

getSupportedLocales() - Method in class org.forgerock.api.models.Operation

Getter of the supported locales array.

getSupportedSortKeys() - Method in class org.forgerock.api.models.Query

Getter of the supported sort keys.

getTags() - Method in class org.forgerock.api.transform.LocalizableOperation

getTitle() - Method in class org.forgerock.api.models.Resource

Getter of title.

getTitle() - Method in class org.forgerock.api.transform.LocalizableRefProperty

getType() - Method in class org.forgerock.api.models.Parameter

Getter of the parameter type.

getType() - Method in class org.forgerock.api.models.Query

Getter of the query type.

getUpdate() - Method in class org.forgerock.api.models.Items

Getter of Update.

getUpdate() - Method in class org.forgerock.api.models.Resource

Getter of Update.

getValue() - Method in class org.forgerock.api.models.Reference

Getter of the JSON reference.

getVersion() - Method in class org.forgerock.api.models.ApiDescription

Getter of version.

getVersions() - Method in class org.forgerock.api.models.VersionedPath

Returns all resource-versions on this path.

getWritePolicy() - Method in class org.forgerock.api.jackson.CrestAnySchema

getWritePolicy() - Method in class org.forgerock.api.jackson.CrestArraySchema

getWritePolicy() - Method in class org.forgerock.api.jackson.CrestBooleanSchema

getWritePolicy() - Method in class org.forgerock.api.jackson.CrestObjectSchema

GONE - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "gone" error.

GONE_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.GONE in an API Description.

H

Handler - Annotation Type in org.forgerock.api.annotations

Details of a handler.

HARDBREAKS - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Hardbreaks attribute preserves line-breaks below its location in the document.

hashCode() - Method in class org.forgerock.api.models.Action

hashCode() - Method in class org.forgerock.api.models.ApiDescription

hashCode() - Method in class org.forgerock.api.models.ApiError

hashCode() - Method in class org.forgerock.api.models.Create

hashCode() - Method in class org.forgerock.api.models.Definitions

hashCode() - Method in class org.forgerock.api.models.Errors

hashCode() - Method in class org.forgerock.api.models.Items

hashCode() - Method in class org.forgerock.api.models.Operation

hashCode() - Method in class org.forgerock.api.models.Parameter

hashCode() - Method in class org.forgerock.api.models.Patch

hashCode() - Method in class org.forgerock.api.models.Paths

hashCode() - Method in class org.forgerock.api.models.Query

hashCode() - Method in class org.forgerock.api.models.Reference

hashCode() - Method in class org.forgerock.api.models.Resource

hashCode() - Method in class org.forgerock.api.models.Schema

hashCode() - Method in class org.forgerock.api.models.Services

hashCode() - Method in class org.forgerock.api.models.SubResources

hashCode() - Method in class org.forgerock.api.models.VersionedPath

HEADER_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Header styles applied.

headers(String...) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Sets the column headers, where blank entries can be null/empty, but the length of the headers array must be equal to the number of columns in the table.

headers(List<String>) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Sets the column headers, where blank entries can be null/empty, but the length of the headers array must be equal to the number of columns in the table.

HORIZONTAL_RULE - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Horizontal rule.

horizontalRule() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a horizontal-rule divider.

HTTP_VERSION_NOT_SUPPORTED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "http version not supported" error.

HTTP_VERSION_NOT_SUPPORTED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.HTTP_VERSION_NOT_SUPPORTED in an API Description.

I

id() - Element in annotation type org.forgerock.api.annotations.ApiError

An identifier for this error condition.

id() - Element in annotation type org.forgerock.api.annotations.Handler

The service identifier.

id() - Element in annotation type org.forgerock.api.annotations.Query

The query ID - required only when type is ID.

id() - Element in annotation type org.forgerock.api.annotations.Schema

The schema identifier.

id(String) - Method in class org.forgerock.api.models.ApiDescription.Builder

Set the id.

ID - Enum constant in enum org.forgerock.api.enums.QueryType

Query run by ID.

ID_FROM_CLIENT - Enum constant in enum org.forgerock.api.enums.CreateMode

The ID is set by the client.

ID_FROM_SERVER - Enum constant in enum org.forgerock.api.enums.CreateMode

The ID is set by the server.

include(String...) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts an include-directive, given a relative path to a file.

INCLUDE - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Include-directive.

INCLUDE_PATTERN - Static variable in class org.forgerock.api.markup.asciidoc.AsciiDoc

Regex for finding Include-directives, where group 1 contains the path-value.

INCREMENT - Enum constant in enum org.forgerock.api.enums.PatchOperation

Increments a numeric field.

integerSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory

INTERNAL - Enum constant in enum org.forgerock.api.enums.Stability

Internal API that may change or be removed at any time.

INTERNAL_SERVER_ERROR - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "internal server error" error.

INTERNAL_SERVER_ERROR_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.INTERNAL_SERVER_ERROR in an API Description.

isEmpty(Object[]) - Static method in class org.forgerock.api.util.ValidationUtil

Determines if an array is null or zero-length.

isEmpty(String) - Static method in class org.forgerock.api.util.ValidationUtil

Determines if a String is null, or empty, or only contains whitespace.

isMvccSupported() - Method in class org.forgerock.api.models.Resource

Informs if MVCC is supported.

isRequired() - Method in class org.forgerock.api.models.Parameter

Getter of the required property.

isSingleNonNull(Object...) - Static method in class org.forgerock.api.util.ValidationUtil

Checks that there is only a single single non-null argument.

isSingleton() - Method in class org.forgerock.api.models.Create

Informs if operation creates singleton resources.

italic(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts italic text.

ITALIC - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Italic text.

items() - Static method in class org.forgerock.api.models.Items

Create a new Builder for Resoruce.

items(Items) - Method in class org.forgerock.api.models.Resource.Builder

Adds items-resource.

Items - Class in org.forgerock.api.models

Class that represents the Items type in API descriptor.

Items.Builder - Class in org.forgerock.api.models

Builder to help construct the Items.

J

JacksonUtils - Class in org.forgerock.api.jackson

Some utilities for working with Jackson, JSON object mapping, and JSON schema.

L

LENGTH_REQUIRED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "length required" error.

LENGTH_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.LENGTH_REQUIRED in an API Description.

LINE_BREAK - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Single line-break.

link(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a cross-reference link.

link(String, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a cross-reference link, with a custom xreflabel.

LIST_CONTINUATION - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

List continuation marker, for including complex markup in a list-item.

listContinuation() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a list-continuation, for adding complex formatted content to a list.

LISTING - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Pre-formatted listing block.

listingBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a listing-block.

listingBlock(String, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a listing-block, with the source-code type (e.g., java, json, etc.) noted for formatting purposes.

LITERAL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Literal block.

LITERAL_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Literal block style.

literalBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a literal-block.

locales() - Element in annotation type org.forgerock.api.annotations.Operation

The list of supported locales for the operation.

LocalizableOperation - Class in org.forgerock.api.transform

Localizable Operation.

LocalizableOperation() - Constructor for class org.forgerock.api.transform.LocalizableOperation

LocalizableRefProperty - Class in org.forgerock.api.transform

Localizable RefProperty.

LocalizableRefProperty() - Constructor for class org.forgerock.api.transform.LocalizableRefProperty

Creates a new LocalizableRefProperty.

LocalizableRefProperty(String) - Constructor for class org.forgerock.api.transform.LocalizableRefProperty

Creates a new LocalizableRefProperty with the given JSON Reference.

LocalizableTag - Class in org.forgerock.api.transform

Localizable Tag.

LocalizableTag() - Constructor for class org.forgerock.api.transform.LocalizableTag

M

merge(String, VersionedPath) - Method in class org.forgerock.api.models.Paths.Builder

Merge the path definition into the existing path definitions.

merge(List<ApiDescription>) - Method in class org.forgerock.api.CrestApiProducer

mergeParameters(List<Parameter>, Parameter...) - Static method in class org.forgerock.api.util.PathUtil

Merges Parameter values into the given parameterList, where conflicting parameter-names will be replaced, and new parameters will otherwise be added.

METHOD_NOT_ALLOWED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "method not allowed" error.

METHOD_NOT_ALLOWED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.METHOD_NOT_ALLOWED in an API Description.

mode(CreateMode) - Method in class org.forgerock.api.models.Create.Builder

Setter for create-mode.

modes() - Element in annotation type org.forgerock.api.annotations.Create

Specify the types of create request that are supported.

mono(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts monospaced (e.g., code) text.

MONO - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Monospaced text.

MONO_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Monospaced font.

MOVE - Enum constant in enum org.forgerock.api.enums.PatchOperation

Moves a field.

MultipleOf - Annotation Type in org.forgerock.api.annotations

Annotation to mark a numeric JSON Schema property's multipleOf field.

MultipleOfSchema - Interface in org.forgerock.api.jackson

Interface defining support for multipleOf JSON Schema field.

mvccSupported() - Element in annotation type org.forgerock.api.annotations.Handler

Whether MVCC style requests are supported.

mvccSupported(Boolean) - Method in class org.forgerock.api.models.Resource.Builder

Setter for MVCC-supported flag.

N

name() - Element in annotation type org.forgerock.api.annotations.Action

The name of the action being exposed.

name() - Element in annotation type org.forgerock.api.annotations.Parameter

The name of the parameter.

name(String) - Method in class org.forgerock.api.models.Action.Builder

Set the Id.

name(String) - Method in class org.forgerock.api.models.Parameter.Builder

Set the parameter name.

name(String) - Method in class org.forgerock.api.transform.LocalizableTag

name(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableTag

Sets the name of the Tag.

newBuilder() - Static method in class org.forgerock.api.models.Schema

Create a new Builder for Schema.

newChildProducer(String) - Method in class org.forgerock.api.CrestApiProducer

newline() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a UNIX newline character, where two adjacent newlines will create a new paragraph.

NEWLINE - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

UNIX newline character.

NONE - Enum constant in enum org.forgerock.api.enums.CountPolicy

No count policy is supported.

normalizeName(String...) - Static method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Normalizes a name such that it can be used as a unique filename and/or anchor in AsciiDoc.

NOT_ACCEPTABLE - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "not acceptable" error.

NOT_ACCEPTABLE_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.NOT_ACCEPTABLE in an API Description.

NOT_FOUND - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "not found" error.

NOT_FOUND_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.NOT_FOUND in an API Description.

NOT_SUPPORTED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "not supported" error.

NOT_SUPPORTED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.NOT_SUPPORTED in an API Description.

nullToFalse(Boolean) - Static method in class org.forgerock.api.util.ValidationUtil

Returns false if the given Boolean parameter is null.

numberSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory

O

OBJECT_MAPPER - Static variable in class org.forgerock.api.jackson.JacksonUtils

A public static ObjectMapper instance, so that they do not have to be instantiated all over the place, as they are expensive to construct.

objectSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory

OFFSET - Enum constant in enum org.forgerock.api.enums.PagingMode

Paging mode is supported by offset.

OpenApiHelper - Class in org.forgerock.api.transform

Helper methods for applying commonly needed changes to the Swagger model.

OpenApiHelper.OperationVisitor - Interface in org.forgerock.api.transform

Visits a Swagger Operation.

OpenApiTransformer - Class in org.forgerock.api.transform

Transforms an ApiDescription into an OpenAPI/Swagger model.

Operation - Class in org.forgerock.api.models

Class that represents the Operation type in API descriptor.

Operation - Annotation Type in org.forgerock.api.annotations

The common details of an operation.

Operation(Operation.Builder) - Constructor for class org.forgerock.api.models.Operation

Protected constructor of the Operation.

Operation.Builder<T extends Operation.Builder<T>> - Class in org.forgerock.api.models

Builder to help construct the Operation.

operationDescription() - Element in annotation type org.forgerock.api.annotations.Action

Describe the standard operation details of this action.

operationDescription() - Element in annotation type org.forgerock.api.annotations.Create

Describe the standard operation details of this action.

operationDescription() - Element in annotation type org.forgerock.api.annotations.Delete

Describe the standard operation details of this action.

operationDescription() - Element in annotation type org.forgerock.api.annotations.Patch

Describe the standard operation details of this action.

operationDescription() - Element in annotation type org.forgerock.api.annotations.Query

Describe the standard operation details of this action.

operationDescription() - Element in annotation type org.forgerock.api.annotations.Read

Describe the standard operation details of this action.

operationDescription() - Element in annotation type org.forgerock.api.annotations.Update

Describe the standard operation details of this action.

operations() - Element in annotation type org.forgerock.api.annotations.Patch

The set of patch operations supported by this request handler.

operations(PatchOperation...) - Method in class org.forgerock.api.models.Patch.Builder

Setter for supported Patch-operations.

operations(Operation...) - Method in class org.forgerock.api.models.Resource.Builder

Allocates the operations given in the parameter by their type.

org.forgerock.api - package org.forgerock.api

ForgeRock API Descriptor models, builders, and utilities.

org.forgerock.api.annotations - package org.forgerock.api.annotations

Annotations that can be used to specify information to be included in the API Descriptor.

org.forgerock.api.commons - package org.forgerock.api.commons

Data related to ForgeRock Commons API Descriptor.

org.forgerock.api.enums - package org.forgerock.api.enums

API descriptor enums.

org.forgerock.api.jackson - package org.forgerock.api.jackson

Extensions to Jackson's JSON Schema to support the API Descriptor extensions to standard JSON Schema.

org.forgerock.api.markup - package org.forgerock.api.markup

Classes that generate CREST API Descriptor documentation.

org.forgerock.api.markup.asciidoc - package org.forgerock.api.markup.asciidoc

AsciiDoc markup builder.

org.forgerock.api.models - package org.forgerock.api.models

ForgeRock API Descriptor models.

org.forgerock.api.transform - package org.forgerock.api.transform

Classes that transform ApiDescription into different API representations.

org.forgerock.api.util - package org.forgerock.api.util

API Descriptor utility classes.

P

PagingMode - Enum in org.forgerock.api.enums

Enum that represents the Query paging mode.

pagingModes() - Element in annotation type org.forgerock.api.annotations.Query

The paging modes that can be used with this query.

pagingModes(PagingMode...) - Method in class org.forgerock.api.models.Query.Builder

Set the paging mode.

parameter() - Static method in class org.forgerock.api.models.Parameter

New parameter builder.

parameter(Parameter) - Method in class org.forgerock.api.models.Operation.Builder

Sets a single supported parameters.

parameter(Parameter) - Method in class org.forgerock.api.models.Resource.Builder

Sets a single supported parameter.

Parameter - Class in org.forgerock.api.models

Class that represents the Parameter type in API descriptor.

Parameter - Annotation Type in org.forgerock.api.annotations

A extra parameter to an operation.

Parameter.Builder - Class in org.forgerock.api.models

Builder to construct Parameter object.

parameters() - Element in annotation type org.forgerock.api.annotations.Handler

Parameters on service paths and/or endpoints.

parameters() - Element in annotation type org.forgerock.api.annotations.Operation

Parameters on operation paths and/or endpoints.

parameters(List<Parameter>) - Method in class org.forgerock.api.models.Operation.Builder

Set multiple supported parameters.

parameters(List<Parameter>) - Method in class org.forgerock.api.models.Resource.Builder

Set multiple supported parameters.

ParameterSource - Enum in org.forgerock.api.enums

Enum that represents where the Parameter comes from.

PASSTHROUGH - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Pass-through block.

passthroughBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a pass-through-block.

patch() - Static method in class org.forgerock.api.models.Patch

Creates a new builder for Patch.

patch(Patch) - Method in class org.forgerock.api.models.Items.Builder

Set Patch.

patch(Patch) - Method in class org.forgerock.api.models.Resource.Builder

Set Patch.

Patch - Class in org.forgerock.api.models

Class that represents the Patch operation type in API descriptor.

Patch - Annotation Type in org.forgerock.api.annotations

Indicates an CREST patch method on an annotated POJO.

Patch.Builder - Class in org.forgerock.api.models

Builder to help construct the Patch.

PatchOperation - Enum in org.forgerock.api.enums

Represents all Patch operations.

Path - Annotation Type in org.forgerock.api.annotations

Allocate a path to a component.

PATH - Enum constant in enum org.forgerock.api.enums.ParameterSource

Parameter comes from the path.

pathParam() - Element in annotation type org.forgerock.api.annotations.CollectionProvider

The name of the path parameter to use in the path descriptors.

pathParameter(Parameter) - Method in class org.forgerock.api.models.Items.Builder

Sets the path parameter for this resource.

paths() - Static method in class org.forgerock.api.models.Paths

Create a new Builder for Paths.

paths(Paths) - Method in class org.forgerock.api.models.ApiDescription.Builder

Set the paths.

Paths - Class in org.forgerock.api.models

Class that represents the Paths type in API descriptor.

Paths.Builder - Class in org.forgerock.api.models

Builder to help construct the Paths.

PathsModule - Class in org.forgerock.api.jackson

Jackson Module that adds a serializer modifier for Paths.

PathsModule() - Constructor for class org.forgerock.api.jackson.PathsModule

Default constructor.

PathUtil - Class in org.forgerock.api.util

Utilities for working with API Description paths and path-parameters.

PAYMENT_REQUIRED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "payment required" error.

PAYMENT_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.PAYMENT_REQUIRED in an API Description.

PRECONDITION_FAILED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "precondition failed" error.

PRECONDITION_FAILED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.PRECONDITION_FAILED in an API Description.

PRECONDITION_REQUIRED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "precondition required" error.

PRECONDITION_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.PRECONDITION_REQUIRED in an API Description.

PropertyOrder - Annotation Type in org.forgerock.api.annotations

Annotation to provide a property order for a given object property.

PropertyPolicies - Annotation Type in org.forgerock.api.annotations

An annotation to declare the policies for property access in the CREST API Descriptor schema elements.

PROXY_AUTH_REQUIRED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "proxy auth required" error.

PROXY_AUTH_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.PROXY_AUTH_REQUIRED in an API Description.

put(String, ApiError) - Method in class org.forgerock.api.models.Errors.Builder

Adds a ApiError.

put(String, Resource) - Method in class org.forgerock.api.models.Services.Builder

Adds a Resource.

put(String, Resource) - Method in class org.forgerock.api.models.SubResources.Builder

Adds a sub-resource.

put(String, Resource) - Method in class org.forgerock.api.models.VersionedPath.Builder

Adds a resource-version.

put(String, Schema) - Method in class org.forgerock.api.models.Definitions.Builder

Adds a Schema.

put(String, VersionedPath) - Method in class org.forgerock.api.models.Paths.Builder

Adds a Path.

put(Version, Resource) - Method in class org.forgerock.api.models.VersionedPath.Builder

Adds a resource-version.

Q

queries(List<Query>) - Method in class org.forgerock.api.models.Resource.Builder

Set Queries.

Queries - Annotation Type in org.forgerock.api.annotations

Declare an array of Query operations from a single method.

query() - Static method in class org.forgerock.api.models.Query

Creates a new builder for Query.

query(Query) - Method in class org.forgerock.api.models.Resource.Builder

Adds one Query to the list of queries.

Query - Class in org.forgerock.api.models

Class that represents the Create Operation type in API descriptor.

Query - Annotation Type in org.forgerock.api.annotations

Indicates an CREST query method on an annotated POJO.

Query.Builder - Class in org.forgerock.api.models

Builder to help construct the Read.

queryableFields() - Element in annotation type org.forgerock.api.annotations.Query

The set of fields that can be used in a query filter.

queryableFields(String...) - Method in class org.forgerock.api.models.Query.Builder

Set the queryable fields.

queryId(String) - Method in class org.forgerock.api.models.Query.Builder

Set the query id.

QueryType - Enum in org.forgerock.api.enums

Enum that represents the Query type.

R

RANGE_NOT_SATISFIABLE - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "range not satisfiable" error.

RANGE_NOT_SATISFIABLE_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.RANGE_NOT_SATISFIABLE in an API Description.

rawLine(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts raw line (may contain markup), and will insert one newline-characters above and below, if those newlines do not already exist.

rawParagraph(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts raw paragraph (may contain markup), and will insert two newline-characters above and below, if those newlines do not already exist [ref].

rawText(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts raw text (may contain markup or only whitespace).

read() - Element in annotation type org.forgerock.api.annotations.PropertyPolicies

The read policy for the property.

read() - Static method in class org.forgerock.api.models.Read

Creates a new builder for Operation.

read(Read) - Method in class org.forgerock.api.models.Items.Builder

Set Read.

read(Read) - Method in class org.forgerock.api.models.Resource.Builder

Set Read.

Read - Class in org.forgerock.api.models

Class that represents the Read Operation type in API descriptor.

Read - Annotation Type in org.forgerock.api.annotations

Indicates an CREST read method on an annotated POJO.

Read.Builder - Class in org.forgerock.api.models

Builder to help construct the Read.

ReadOnly - Annotation Type in org.forgerock.api.annotations

Annotation to mark a JSON Schema property as read-only.

ReadPolicy - Enum in org.forgerock.api.enums

Enum that represents the Schema read policies.

reference() - Static method in class org.forgerock.api.models.Reference

Create a new Builder for Reference.

reference(Reference) - Method in class org.forgerock.api.models.ApiError.Builder

Set the error as a reference to another definition.

reference(Reference) - Method in class org.forgerock.api.models.Resource.Builder

Set a reference.

reference(Reference) - Method in class org.forgerock.api.models.Schema.Builder

Sets the schema reference.

Reference - Class in org.forgerock.api.models

Class that represents the Reference type in API descriptor.

Reference.Builder - Class in org.forgerock.api.models

Builder to help construct the Reference.

ReferenceResolver - Class in org.forgerock.api.util

Helper that registers one or more ApiDescription instances and provides a means to resolve References.

ReferenceResolver(ApiDescription) - Constructor for class org.forgerock.api.util.ReferenceResolver

Creates a reference-resolver and defines the one ApiDescription that can be used for local (non-namespaced) reference lookups.

register(ApiDescription) - Method in class org.forgerock.api.util.ReferenceResolver

Registers an external ApiDescription, for Reference lookup, and must not have previously been registered.

registerAll(ApiDescription...) - Method in class org.forgerock.api.util.ReferenceResolver

Registers external ApiDescriptions, for Reference lookup, and each must not have previously been registered.

REMOVE - Enum constant in enum org.forgerock.api.enums.PatchOperation

Removes a field.

REMOVED - Enum constant in enum org.forgerock.api.enums.Stability

Removed API, that remains available for some technical reason and may return an error if used.

REPLACE - Enum constant in enum org.forgerock.api.enums.PatchOperation

Replaces a field.

request() - Element in annotation type org.forgerock.api.annotations.Action

Describe the schema of the request payload.

request(Schema) - Method in class org.forgerock.api.models.Action.Builder

Set the request.

REQUEST_ENTITY_TOO_LARGE - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "request entity too large" error.

REQUEST_ENTITY_TOO_LARGE_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.REQUEST_ENTITY_TOO_LARGE in an API Description.

REQUEST_HANDLER - Enum constant in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant

A plain request handler (expects all operations).

REQUEST_TIMEOUT - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "request timeout" error.

REQUEST_TIMEOUT_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.REQUEST_TIMEOUT in an API Description.

REQUEST_URI_TOO_LARGE - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "request uri too large" error.

REQUEST_URI_TOO_LARGE_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.REQUEST_URI_TOO_LARGE in an API Description.

RequestHandler - Annotation Type in org.forgerock.api.annotations

A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST request handler.

required() - Element in annotation type org.forgerock.api.annotations.Parameter

Whether the parameter is required.

required(Boolean) - Method in class org.forgerock.api.models.Parameter.Builder

Set the required property.

resource() - Static method in class org.forgerock.api.models.Resource

Create a new Builder for Resoruce.

Resource - Class in org.forgerock.api.models

Class that represents the Resource type in API descriptor.

Resource.AnnotatedTypeVariant - Enum in org.forgerock.api.models

The variant of the annotated type.

Resource.Builder - Class in org.forgerock.api.models

Builder to help construct the Resource.

resourceSchema() - Element in annotation type org.forgerock.api.annotations.Handler

The schema for all the standard resource operations (CRUDPQ) on this endpoint.

resourceSchema(Schema) - Method in class org.forgerock.api.models.Resource.Builder

Set the resource schema.

response() - Element in annotation type org.forgerock.api.annotations.Action

Describe the schema of the response payload.

response(Schema) - Method in class org.forgerock.api.models.Action.Builder

Set the response.

returnOnDemand() - Element in annotation type org.forgerock.api.annotations.PropertyPolicies

true when a field is available, but must be explicitly requested, or false (default) when always returned.

rowEnd() - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Adds an optional space to visually delineate the end of a row in the generated markup.

S

safeValueOf(Double) - Static method in class org.forgerock.api.util.BigDecimalUtil

Convert a nullable Double into a BigDecimal value.

schema() - Static method in class org.forgerock.api.models.Schema

Create a new Builder for Schema.

schema(String, Object) - Method in class org.forgerock.api.models.Schema.Builder

Sets the schema by json key-value pairs.

schema(Schema) - Method in class org.forgerock.api.models.ApiError.Builder

Set the schema.

schema(JsonValue) - Method in class org.forgerock.api.models.Schema.Builder

Sets the schema.

Schema - Class in org.forgerock.api.models

Class that represents the Schema type in API descriptor.

Schema - Annotation Type in org.forgerock.api.annotations

Specify a schema for the element that is being described.

Schema.Builder - Class in org.forgerock.api.models

A builder class for Schema instances.

schemaFor(Class<?>) - Static method in class org.forgerock.api.jackson.JacksonUtils

Obtain the JsonSchema for a type, using the extended schema classes that are in this package.

schemaResource() - Element in annotation type org.forgerock.api.annotations.Schema

A classpath resource that contains a JSON Schema structure to be used.

SECTION_TITLE_1 - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Section title, level 1.

SECTION_TITLE_2 - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Section title, level 2.

SECTION_TITLE_3 - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Section title, level 3.

SECTION_TITLE_4 - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Section title, level 4.

SECTION_TITLE_5 - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Section title, level 5.

sectionTitle(String, int) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a section title, at a given level.

sectionTitle1(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a section title, level 1.

sectionTitle2(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a section title, level 2.

sectionTitle3(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a section title, level 3.

sectionTitle4(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a section title, level 4.

sectionTitle5(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a section title, level 5.

self() - Method in class org.forgerock.api.models.Action.Builder

self() - Method in class org.forgerock.api.models.Create.Builder

Returns the builder so this.

self() - Method in class org.forgerock.api.models.Delete.Builder

self() - Method in class org.forgerock.api.models.Operation.Builder

Abstract method that returns the instantiated Builder itself.

self() - Method in class org.forgerock.api.models.Patch.Builder

self() - Method in class org.forgerock.api.models.Query.Builder

Returns the builder instance.

self() - Method in class org.forgerock.api.models.Read.Builder

Returns the builder instance.

self() - Method in class org.forgerock.api.models.Update.Builder

SERVER - Enum constant in enum org.forgerock.api.enums.ReadPolicy

Property is available internally, but not exposed to client APIs.

services() - Static method in class org.forgerock.api.models.Services

Create a new Builder for Services.

services(Services) - Method in class org.forgerock.api.models.ApiDescription.Builder

Set the services.

Services - Class in org.forgerock.api.models

Class that represents API descriptor's Service Resource definitions.

Services.Builder - Class in org.forgerock.api.models

Builder to help construct the Services.

setDescription(String) - Method in class org.forgerock.api.transform.LocalizableOperation

setDescription(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty

setDescription(String) - Method in class org.forgerock.api.transform.LocalizableTag

setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestAnySchema

setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestArraySchema

setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestBooleanSchema

setErrorOnWritePolicyFailure(Boolean) - Method in class org.forgerock.api.jackson.CrestObjectSchema

setExample(String) - Method in class org.forgerock.api.jackson.CrestAnySchema

setExample(String) - Method in class org.forgerock.api.jackson.CrestArraySchema

setExample(String) - Method in class org.forgerock.api.jackson.CrestBooleanSchema

setExample(String) - Method in class org.forgerock.api.jackson.CrestObjectSchema

setExample(String) - Method in interface org.forgerock.api.jackson.WithExampleSchema

Sets example JSON Schema field.

setFormat(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty

Pull method from AbstractProperty into this interface.

setMultipleOf(Double) - Method in interface org.forgerock.api.jackson.MultipleOfSchema

Sets multipleOf JSON Schema field.

setName(String) - Method in class org.forgerock.api.transform.LocalizableTag

setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestAnySchema

setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestArraySchema

setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestBooleanSchema

setPropertyOrder(Integer) - Method in class org.forgerock.api.jackson.CrestObjectSchema

setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestAnySchema

setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestArraySchema

setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestBooleanSchema

setReadPolicy(ReadPolicy) - Method in class org.forgerock.api.jackson.CrestObjectSchema

setRequiredFields(Set<String>) - Method in class org.forgerock.api.jackson.CrestObjectSchema

setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestAnySchema

setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestArraySchema

setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestBooleanSchema

setReturnOnDemand(Boolean) - Method in class org.forgerock.api.jackson.CrestObjectSchema

setTags(List<String>) - Method in class org.forgerock.api.transform.LocalizableOperation

setTitle(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty

setVendorExtension(String, Object) - Method in class org.forgerock.api.transform.LocalizableRefProperty

Pull method from AbstractProperty into this interface.

setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestAnySchema

setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestArraySchema

setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestBooleanSchema

setWritePolicy(WritePolicy) - Method in class org.forgerock.api.jackson.CrestObjectSchema

SIDEBAR - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Sidebar block.

sidebarBlock(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a sidebar-block.

singleton() - Element in annotation type org.forgerock.api.annotations.Create

Specify whether or not the created resource is a singleton or one of a collection.

singleton(Boolean) - Method in class org.forgerock.api.models.Create.Builder

Setter for singleton.

SINGLETON_RESOURCE - Enum constant in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant

A singleton resource handler.

SingletonProvider - Annotation Type in org.forgerock.api.annotations

A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST singleton provider resource.

sortKeys() - Element in annotation type org.forgerock.api.annotations.Query

The keys that can be used to sort the results of the query.

source() - Element in annotation type org.forgerock.api.annotations.Parameter

The source of the parameter.

source(ParameterSource) - Method in class org.forgerock.api.models.Parameter.Builder

Set the parameter source.

stability() - Element in annotation type org.forgerock.api.annotations.Operation

The stability state for the operation.

stability(Stability) - Method in class org.forgerock.api.models.Operation.Builder

Sets stability of Operation.

Stability - Enum in org.forgerock.api.enums

Represents API stability.

STABLE - Enum constant in enum org.forgerock.api.enums.Stability

Stable API (default), suggested for use by all clients.

stringSchema() - Method in class org.forgerock.api.jackson.CrestJsonSchemaFactory

STRONG_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Bold text.

subresources() - Static method in class org.forgerock.api.models.SubResources

Create a new Builder for sub-resources.

subresources(SubResources) - Method in class org.forgerock.api.models.Items.Builder

Sets the sub-resources for this resource.

subresources(SubResources) - Method in class org.forgerock.api.models.Resource.Builder

Sets the sub-resources for this resource.

SubResources - Class in org.forgerock.api.models

Sub-resources of a resource are declared here.

SubResources.Builder - Class in org.forgerock.api.models

Builder to help construct the SubResources.

supportedLocales(String...) - Method in class org.forgerock.api.models.Operation.Builder

Set the supported locale.

supportedSortKeys(String...) - Method in class org.forgerock.api.models.Query.Builder

Set the supported sort keys.

T

TABLE - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Start/end of table.

TABLE_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Table-cell delimiter.

TABLE_OF_CONTENTS - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Table-of-Contents directive.

tableEnd() - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Completes the table being built, and inserts it at the end of the parent document.

tableStart() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Starts a table at the current position.

title() - Element in annotation type org.forgerock.api.annotations.Handler

Service title, for documentation purposes.

title(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDocTable

Sets a table-title.

title(String) - Method in class org.forgerock.api.models.Resource.Builder

Set the title.

title(String) - Method in class org.forgerock.api.transform.LocalizableRefProperty

title(LocalizableString) - Method in class org.forgerock.api.models.Resource.Builder

Set the title.

title(LocalizableString) - Method in class org.forgerock.api.transform.LocalizableRefProperty

Title - Annotation Type in org.forgerock.api.annotations

Annotation to define JSON Schema property's title.

toFile(Path, String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Saves builder content to a file.

toString() - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Converts builder content to a String.

toString() - Method in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Returns the AsciiDocSymbols markup symbol associated with this item.

toString() - Method in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Returns the character associated with the table column-style.

TRANSFORM - Enum constant in enum org.forgerock.api.enums.PatchOperation

Transforms a field.

TransformerException - Exception in org.forgerock.api.transform

Signals that an error occurred while transforming an API Description to another format.

TransformerException(String) - Constructor for exception org.forgerock.api.transform.TransformerException

Creates a TransformerException with a detailed error message.

TransformerException(String, Throwable) - Constructor for exception org.forgerock.api.transform.TransformerException

Creates a TransformerException with a detailed error message and cause.

TranslateJsonSchema - Class in org.forgerock.api.models

Iterates over each JsonValue node in the JsonValue structure and if it's a String marked for translation, It replaces the String with a LocalizableString.

TranslateJsonSchema(ClassLoader) - Constructor for class org.forgerock.api.models.TranslateJsonSchema

Constructor which takes a ClassLoader where the String is defined.

TRUE - Enum constant in enum org.forgerock.api.enums.CreateSingleton

The created resource is a singleton.

type() - Element in annotation type org.forgerock.api.annotations.Parameter

The type semantics of the String value.

type() - Element in annotation type org.forgerock.api.annotations.Query

The type of query this method supports.

type(Class<?>) - Method in class org.forgerock.api.models.Schema.Builder

Sets the schema.

type(String) - Method in class org.forgerock.api.models.Parameter.Builder

Set the parameter type.

type(QueryType) - Method in class org.forgerock.api.models.Query.Builder

Set the query type.

U

UNAUTHORIZED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "unauthorized" error.

UNAUTHORIZED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.UNAUTHORIZED in an API Description.

UNAVAILABLE - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "unavailable" error.

UNAVAILABLE_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.UNAVAILABLE in an API Description.

UniqueItems - Annotation Type in org.forgerock.api.annotations

Annotation to mark a JSON Schema array-items as unique.

UNORDERED_LIST_1 - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Unordered list item at level-1.

unorderedList1(String) - Method in class org.forgerock.api.markup.asciidoc.AsciiDoc

Inserts a line for an unordered list, at level 1 indentation.

UNSUPPORTED_MEDIA_TYPE - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "unsupported media type" error.

UNSUPPORTED_MEDIA_TYPE_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.UNSUPPORTED_MEDIA_TYPE in an API Description.

UNVERSIONED - Static variable in class org.forgerock.api.models.VersionedPath

Version 0.0 represents null/empty, for when resource versions are not required by an API (e.g., OpenIDM).

update() - Static method in class org.forgerock.api.models.Update

Creates a new builder for Operation.

update(Update) - Method in class org.forgerock.api.models.Items.Builder

Set Update.

update(Update) - Method in class org.forgerock.api.models.Resource.Builder

Set Update.

Update - Class in org.forgerock.api.models

Class that represents the Create Operation type in API descriptor.

Update - Annotation Type in org.forgerock.api.annotations

Indicates an CREST update method on an annotated POJO.

Update.Builder - Class in org.forgerock.api.models

Builder to help construct Update.

USER - Enum constant in enum org.forgerock.api.enums.ReadPolicy

Property is readable via client APIs and visible in the user-interface.

V

validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestAnySchema

validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestArraySchema

validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestBooleanSchema

validate(JsonValue) - Method in class org.forgerock.api.jackson.CrestObjectSchema

validateJsonToSchema(String, JsonSchema) - Static method in class org.forgerock.api.jackson.JacksonUtils

Validate that the provided JSON conforms to the schema.

ValidationUtil - Class in org.forgerock.api.util

API Descriptor model-validation utilities.

value() - Element in annotation type org.forgerock.api.annotations.Actions

The actions.

value() - Element in annotation type org.forgerock.api.annotations.AdditionalProperties

The type to produce the additional-properties schema from.

value() - Element in annotation type org.forgerock.api.annotations.Default

The default-value of the property.

value() - Element in annotation type org.forgerock.api.annotations.Description

The description of the property.

value() - Element in annotation type org.forgerock.api.annotations.EnumTitle

The title of the enum value.

value() - Element in annotation type org.forgerock.api.annotations.Example

String representation of the example.

value() - Element in annotation type org.forgerock.api.annotations.Format

The format value of the property.

value() - Element in annotation type org.forgerock.api.annotations.MultipleOf

The multipleOf value of the property.

value() - Element in annotation type org.forgerock.api.annotations.Path

The path value.

value() - Element in annotation type org.forgerock.api.annotations.PropertyOrder

The order value of the property.

value() - Element in annotation type org.forgerock.api.annotations.Queries

The queries.

value() - Element in annotation type org.forgerock.api.annotations.ReadOnly

The read-only value of the property.

value() - Element in annotation type org.forgerock.api.annotations.RequestHandler

The details of the handler.

value() - Element in annotation type org.forgerock.api.annotations.SingletonProvider

The details of the handler.

value() - Element in annotation type org.forgerock.api.annotations.Title

The title of the property.

value() - Element in annotation type org.forgerock.api.annotations.UniqueItems

The unique-items value of the property.

value(String) - Method in class org.forgerock.api.models.Reference.Builder

Setter for Reference-value.

valueOf(String) - Static method in enum org.forgerock.api.commons.CommonsApi.Errors

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.CountPolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.CreateMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.CreateSingleton

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.PagingMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.ParameterSource

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.PatchOperation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.QueryType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.ReadPolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.Stability

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.enums.WritePolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.forgerock.api.commons.CommonsApi.Errors

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.CountPolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.CreateMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.CreateSingleton

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.PagingMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.ParameterSource

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.PatchOperation

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.QueryType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.ReadPolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.Stability

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.enums.WritePolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocSymbols

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.forgerock.api.models.Resource.AnnotatedTypeVariant

Returns an array containing the constants of this enum type, in the order they are declared.

VERSE_CELL - Enum constant in enum org.forgerock.api.markup.asciidoc.AsciiDocTableColumnStyles

Cell treated like it was a verse block.

version(String) - Method in class org.forgerock.api.models.ApiDescription.Builder

Set the version of the API.

VERSION_MISMATCH - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "version mismatch" error.

VERSION_MISMATCH_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.VERSION_MISMATCH in an API Description.

VERSION_REQUIRED - Enum constant in enum org.forgerock.api.commons.CommonsApi.Errors

The "version required " error.

VERSION_REQUIRED_REF - Static variable in class org.forgerock.api.commons.CommonsApi

JSON Reference to CommonsApi.Errors.VERSION_REQUIRED in an API Description.

versionedPath() - Static method in class org.forgerock.api.models.VersionedPath

Create a new Builder for VersionedPath.

VersionedPath - Class in org.forgerock.api.models

Class that represents versioned Resources on an API descriptor path.

VersionedPath.Builder - Class in org.forgerock.api.models

Builder to help construct the VersionedPath.

visit(Operation) - Method in interface org.forgerock.api.transform.OpenApiHelper.OperationVisitor

Visits a Swagger Operation.

visitAllOperations(OpenApiHelper.OperationVisitor, Swagger) - Static method in class org.forgerock.api.transform.OpenApiHelper

Visits all operations.

W

WithExampleSchema<T> - Interface in org.forgerock.api.jackson

Extension for CREST and OpenAPI schemas to express an example value.

withPath(ApiDescription, String) - Method in class org.forgerock.api.CrestApiProducer

withVersion(ApiDescription, Version) - Method in class org.forgerock.api.CrestApiProducer

WRITABLE - Enum constant in enum org.forgerock.api.enums.WritePolicy

The property can be set at any time.

write() - Element in annotation type org.forgerock.api.annotations.PropertyPolicies

The write policy for the property.

WRITE_ON_CREATE - Enum constant in enum org.forgerock.api.enums.WritePolicy

The property MAY be set in the create request, but not thereafter.

WRITE_ONCE - Enum constant in enum org.forgerock.api.enums.WritePolicy

The property MAY be set only if the current value is NULL.

WritePolicy - Enum in org.forgerock.api.enums

Enum that represents the Schema write policies.

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