de.smartics.properties.admin.resources.controller
Class ApiResource

java.lang.Object
  de.smartics.properties.admin.resources.controller.ApiResource

@Path(value="")
public class ApiResource
     
     

      
      extends 
      
      Object
     
     

Provides access information about the API.

Field Summary

static ApiServices.ServiceDescriptor	CONFIGURATIONS The service to configure configurations.
static ApiServices.ServiceDescriptor	DESCRIPTOR The service to view a selected property descriptor.
static ApiServices.ServiceDescriptor	DESCRIPTORS The service to browse property descriptors.
static ApiServices.ServiceDescriptor	JNDI The service configure JNDI properties.
static ApiServices.ServiceDescriptor	SECURITY The service to en- and decrypt property values.

Constructor Summary

ApiResource()

Method Summary

javax.ws.rs.core.Response	getAsHtml() Provides a list of services in HTML.
javax.ws.rs.core.Response	getAsXml() Provides a list of services in XML.
javax.ws.rs.core.Response	logout() Allows to logout the user.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATIONS

public static final ApiServices.ServiceDescriptor CONFIGURATIONS

The service to configure configurations.

SECURITY

public static final ApiServices.ServiceDescriptor SECURITY

The service to en- and decrypt property values.

JNDI

public static final ApiServices.ServiceDescriptor JNDI

The service configure JNDI properties.

DESCRIPTORS

public static final ApiServices.ServiceDescriptor DESCRIPTORS

The service to browse property descriptors.

DESCRIPTOR

public static final ApiServices.ServiceDescriptor DESCRIPTOR

The service to view a selected property descriptor.

Constructor Detail

ApiResource

public ApiResource()

Method Detail

getAsHtml

@GET
@Produces(value="text/html")
public javax.ws.rs.core.Response getAsHtml()

Provides a list of services in HTML.

Returns:

a response to redirect.

getAsXml

@GET
@Produces(value={"text/xml","application/xml"})
public javax.ws.rs.core.Response getAsXml()

Provides a list of services in XML.

Returns:

a response to redirect.

logout

@POST
@Path(value="user/logout")
@Produces(value={"text/html","text/xml","application/xml"})
public javax.ws.rs.core.Response logout()
                                 throws javax.servlet.ServletException

Allows to logout the user.

Returns:

the response to render on successful logout.

Throws:

javax.servlet.ServletException - on any problem encountered while logging out the user.