Package org.mycore.restapi.v1

Class MCRRestAPIMessages

java.lang.Object

org.mycore.restapi.v1.MCRRestAPIMessages

@Path("/messages")
public class MCRRestAPIMessages
extends Object

REST API for messages. Allows access to message properties of the application

Version:

$Revision: $ $Date: $

Author:

Robert Stephan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORMAT_JSON
static final String	FORMAT_PROPERTY
static final String	FORMAT_XML

Constructor Summary

Constructors

Constructor	Description
MCRRestAPIMessages()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getMessage(jakarta.ws.rs.core.UriInfo info, jakarta.servlet.http.HttpServletRequest request, String key, String lang, String format)	returns a single messages entry.
jakarta.ws.rs.core.Response	listMessages(jakarta.ws.rs.core.UriInfo info, jakarta.servlet.http.HttpServletRequest request, String lang, String format, String filter)	lists all message properties for a given language

Methods inherited from class java.lang.Object

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

Field Details

FORMAT_JSON

public static final String FORMAT_JSON

See Also:

• Constant Field Values

FORMAT_XML

public static final String FORMAT_XML

See Also:

• Constant Field Values

FORMAT_PROPERTY

public static final String FORMAT_PROPERTY

See Also:

• Constant Field Values

Constructor Details

MCRRestAPIMessages

public MCRRestAPIMessages()

Method Details

listMessages

@GET
@Produces({"text/xml;charset=UTF-8","application/json;charset=UTF-8","text/plain;charset=ISO-8859-1"})
public jakarta.ws.rs.core.Response listMessages(@Context
 jakarta.ws.rs.core.UriInfo info,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @QueryParam("lang") @DefaultValue("de")
 String lang,
 @QueryParam("format") @DefaultValue("property")
 String format,
 @QueryParam("filter") @DefaultValue("")
 String filter)

lists all message properties for a given language

Parameters:

info - - the injected Jersey Context Object for URI

request - - the injected HTTPServletRequest object

lang - - the language in which the messages should be returned (default: 'de')

format - Possible values are: props (default) | json | xml

filter - ';'-separated list of message key prefixes

Returns:

a Jersey Response object

getMessage

@GET
@Path("/{value}")
@Produces({"text/xml;charset=UTF-8","application/json;charset=UTF-8","text/plain;charset=UTF-8"})
public jakarta.ws.rs.core.Response getMessage(@Context
 jakarta.ws.rs.core.UriInfo info,
 @Context
 jakarta.servlet.http.HttpServletRequest request,
 @PathParam("value")
 String key,
 @QueryParam("lang") @DefaultValue("de")
 String lang,
 @QueryParam("format") @DefaultValue("text")
 String format)

returns a single messages entry.

Parameters:

info - - the injected Jersey context object for URI

request - - the injected HTTPServletRequest object

key - - the message key

lang - - the language

format - Possible values are: props (default) | json | xml (required)

Returns:

a Jersey Response Object