org.apache.isis.viewer.restfulobjects.rendering.service.conneg

Class ContentNegotiationServiceOrgApacheIsisV1

java.lang.Object

org.apache.isis.viewer.restfulobjects.rendering.service.conneg.ContentNegotiationServiceAbstract

org.apache.isis.viewer.restfulobjects.rendering.service.conneg.ContentNegotiationServiceOrgApacheIsisV1

All Implemented Interfaces:

ContentNegotiationService

@Service
 @Named(value="isisRoRendering.ContentNegotiationServiceOrgApacheIsisV1")
 @Order(value=-200)
 @Qualifier(value="OrgApacheIsisV1")
public class ContentNegotiationServiceOrgApacheIsisV1
extends ContentNegotiationServiceAbstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_PROFILE Unlike RO v1.0, use a single content-type of application/json;profile="urn:org.apache.isis/v1".
static String	CONTENT_TYPE_OAI_V1_LIST The media type (as a string) used as the content-Type header when a standalone collection is rendered.
static String	CONTENT_TYPE_OAI_V1_OBJECT The media type (as a string) used as the content-Type header when a domain object is rendered.
static String	CONTENT_TYPE_OAI_V1_OBJECT_COLLECTION The media type (as a string) used as the content-Type header when a parented collection is rendered.

Constructor Summary

Constructors

Constructor and Description
ContentNegotiationServiceOrgApacheIsisV1(ContentNegotiationServiceForRestfulObjectsV1_0 restfulObjectsV1_0)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response.ResponseBuilder	buildResponse(IResourceContext resourceContext, org.apache.isis.core.metamodel.spec.ManagedObject objectAdapter) Domain object is returned as a map with the RO 1.0 representation as a special '$$ro' property within that map.
javax.ws.rs.core.Response.ResponseBuilder	buildResponse(IResourceContext resourceContext, ObjectAndAction objectAndAction) Action prompt is not supported.
javax.ws.rs.core.Response.ResponseBuilder	buildResponse(IResourceContext resourceContext, ObjectAndActionInvocation objectAndActionInvocation) Action invocation is supported provided it returns a single domain object or a list of domain objects (ie invocations returning void or scalar value are not supported).
javax.ws.rs.core.Response.ResponseBuilder	buildResponse(IResourceContext resourceContext, ObjectAndCollection objectAndCollection) Individual (parented) collection of an object is returned as a list with the RO representation as an object in the list with a single property named '$$ro'
javax.ws.rs.core.Response.ResponseBuilder	buildResponse(IResourceContext resourceContext, ObjectAndProperty objectAndProperty) Individual property of an object is not supported.
protected javax.ws.rs.core.Response.ResponseBuilder	responseBuilder(javax.ws.rs.core.Response.ResponseBuilder responseBuilder) For easy subclassing to further customize, eg additional headers
protected EnumSet<org.apache.isis.applib.client.SuppressionType>	suppress(IResourceContext resourceContext)

Methods inherited from class org.apache.isis.viewer.restfulobjects.rendering.service.conneg.ContentNegotiationServiceAbstract

ensureDomainObjectAssignable, ensureJaxbAnnotated, loadClass, mediaTypeParameterList, mediaTypeParameterMatches, objectOf, returnedObjectOf

Methods inherited from class java.lang.Object

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

Field Detail

ACCEPT_PROFILE

public static final String ACCEPT_PROFILE

Unlike RO v1.0, use a single content-type of application/json;profile="urn:org.apache.isis/v1".

The response content types (CONTENT_TYPE_OAI_V1_OBJECT, CONTENT_TYPE_OAI_V1_OBJECT_COLLECTION, CONTENT_TYPE_OAI_V1_LIST) append the 'repr-type' parameter.

See Also:

Constant Field Values

CONTENT_TYPE_OAI_V1_OBJECT

public static final String CONTENT_TYPE_OAI_V1_OBJECT

The media type (as a string) used as the content-Type header when a domain object is rendered.

See Also:

for discussion., Constant Field Values

CONTENT_TYPE_OAI_V1_OBJECT_COLLECTION

public static final String CONTENT_TYPE_OAI_V1_OBJECT_COLLECTION

The media type (as a string) used as the content-Type header when a parented collection is rendered.

See Also:

for discussion., Constant Field Values

CONTENT_TYPE_OAI_V1_LIST

public static final String CONTENT_TYPE_OAI_V1_LIST

The media type (as a string) used as the content-Type header when a standalone collection is rendered.

See Also:

for discussion., Constant Field Values

Constructor Detail

ContentNegotiationServiceOrgApacheIsisV1

public ContentNegotiationServiceOrgApacheIsisV1(ContentNegotiationServiceForRestfulObjectsV1_0 restfulObjectsV1_0)

Method Detail

buildResponse

public javax.ws.rs.core.Response.ResponseBuilder buildResponse(IResourceContext resourceContext,
                                                               org.apache.isis.core.metamodel.spec.ManagedObject objectAdapter)

Domain object is returned as a map with the RO 1.0 representation as a special '$$ro' property within that map.

Specified by:

buildResponse in interface ContentNegotiationService

Overrides:

buildResponse in class ContentNegotiationServiceAbstract

buildResponse

public javax.ws.rs.core.Response.ResponseBuilder buildResponse(IResourceContext resourceContext,
                                                               ObjectAndProperty objectAndProperty)

Individual property of an object is not supported.

Specified by:

buildResponse in interface ContentNegotiationService

Overrides:

buildResponse in class ContentNegotiationServiceAbstract

buildResponse

public javax.ws.rs.core.Response.ResponseBuilder buildResponse(IResourceContext resourceContext,
                                                               ObjectAndCollection objectAndCollection)

Individual (parented) collection of an object is returned as a list with the RO representation as an object in the list with a single property named '$$ro'

Specified by:

buildResponse in interface ContentNegotiationService

Overrides:

buildResponse in class ContentNegotiationServiceAbstract

buildResponse

public javax.ws.rs.core.Response.ResponseBuilder buildResponse(IResourceContext resourceContext,
                                                               ObjectAndAction objectAndAction)

Action prompt is not supported.

Specified by:

buildResponse in interface ContentNegotiationService

Overrides:

buildResponse in class ContentNegotiationServiceAbstract

buildResponse

public javax.ws.rs.core.Response.ResponseBuilder buildResponse(IResourceContext resourceContext,
                                                               ObjectAndActionInvocation objectAndActionInvocation)

Action invocation is supported provided it returns a single domain object or a list of domain objects (ie invocations returning void or scalar value are not supported). Action invocations returning a domain object will be rendered as a map with the RO v1.0 representation as a '$$ro' property within (same as #buildResponse(RepresentationService.Context2, ManagedObject)), while action invocations returning a list will be rendered as a list with the RO v1.0 representation as a map object with a single '$$ro' property (similar to #buildResponse(RepresentationService.Context2, ObjectAndCollection))

Specified by:

buildResponse in interface ContentNegotiationService

Overrides:

buildResponse in class ContentNegotiationServiceAbstract

responseBuilder

protected javax.ws.rs.core.Response.ResponseBuilder responseBuilder(javax.ws.rs.core.Response.ResponseBuilder responseBuilder)

For easy subclassing to further customize, eg additional headers

suppress

protected EnumSet<org.apache.isis.applib.client.SuppressionType> suppress(IResourceContext resourceContext)