Package de.xima.fc.api.rest.services

Class RootService

java.lang.Object

de.xima.fc.api.rest.services.RootService

@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Path("/")
@FcSecurity(authorizers="none")
public class RootService
extends Object

Service providing base functionality of the REST API

Since:

8.2.0

Author:

XIMA Media GmbH

Constructor Summary

Constructors

Constructor	Description
RootService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getEntryPoint()
javax.ws.rs.core.Response	getOpenApi(javax.ws.rs.core.HttpHeaders headers, String type)
javax.ws.rs.core.Response	ping(org.pac4j.core.profile.CommonProfile profile)

Methods inherited from class java.lang.Object

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

Constructor Detail

RootService

public RootService()

Method Detail

getEntryPoint

@GET
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public javax.ws.rs.core.Response getEntryPoint()

ping

@GET
@Path("/ping")
public javax.ws.rs.core.Response ping(@Pac4JProfile
                                      org.pac4j.core.profile.CommonProfile profile)

getOpenApi

@GET
@Path("/doc/openapi.{type:json|yaml}")
@Produces({"application/json; charset=utf-8","application/yaml; charset=utf-8"})
public javax.ws.rs.core.Response getOpenApi(@Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @PathParam("type")
                                            String type)
                                     throws Exception

Throws:

Exception