A B C D F G H I J M N O P R S T U V W X

A

addObject2Request(String, Object) - Method in class net.sf.serfj.RestController

Deprecated.

Use putParam(String name, Object object)

ALIAS_CONTROLLERS_PACKAGE - Static variable in class net.sf.serfj.Config

Java package where controllers will be located.

ALIAS_SERIALIZERS_PACKAGE - Static variable in class net.sf.serfj.Config

Java package where serializers for responses will be located.

B

Base64Serializer - Class in net.sf.serfj.serializers

Default base64 serializer/deserializer.

Base64Serializer() - Constructor for class net.sf.serfj.serializers.Base64Serializer

C

capitalize(String) - Method in class net.sf.serfj.util.UrlUtils

Changes the first character to uppercase.

cleanURL(String) - Method in class net.sf.serfj.util.UrlUtils

Removes the query string and the extension of a REST URL.

Client - Class in net.sf.serfj.client

Client to manage REST calls to a REST Controller.

Client() - Constructor for class net.sf.serfj.client.Client

Constructor.

Client(String) - Constructor for class net.sf.serfj.client.Client

Constructor.

Config - Class in net.sf.serfj

Framework configuration.

Config(String) - Constructor for class net.sf.serfj.Config

ConfigFileIOException - Exception in net.sf.serfj.config

Configuration file not found or can't read it.

ConfigFileIOException(String) - Constructor for exception net.sf.serfj.config.ConfigFileIOException

Constructor with a message.

ConfigParam - Class in net.sf.serfj.config

Clase en la que se definen los diferentes parametros de configuracion que se van a utilizar en el cliente, y los que son comunes a los dos.

ConfigParam(String) - Constructor for class net.sf.serfj.config.ConfigParam

Constructor con el nombre del parametro.

ConfigParam(String, String) - Constructor for class net.sf.serfj.config.ConfigParam

Constructor con valor por defecto.

ControllerFinder - Class in net.sf.serfj.finders

This class is used to find a controller.

ControllerFinder(Config) - Constructor for class net.sf.serfj.finders.ControllerFinder

D

DEBUG - Static variable in class net.sf.serfj.Config

Flag for debug purposes.

DEFAULT_PACKAGE - Static variable in class net.sf.serfj.finders.ResourceFinder

Default package for classes used when some class is not found and there is a SERFJ implementation for something.

DEFAULT_SERIALIZERS_PACKAGE - Static variable in class net.sf.serfj.finders.SerializerFinder

defaultResource(String) - Method in class net.sf.serfj.finders.ResourceFinder

Gets the default resource in case finder can't find an implementation.

defaultResource(String) - Method in class net.sf.serfj.finders.SerializerFinder

DELETE - Annotation Type in net.sf.serfj.annotations

Annotation used to mark a resource method that responds to HTTP DELETE requests.

deleteRequest(String, Map<String, String>) - Method in class net.sf.serfj.client.Client

Do a DELETE HTTP request to the given REST-URL.

deserialize(String) - Method in class net.sf.serfj.serializers.Base64Serializer

Deserialze base 64 encoded string data to Object.

deserialize(String) - Method in class net.sf.serfj.serializers.JsonSerializer

Deserializes a Json string representation to an object.

deserialize(String) - Method in interface net.sf.serfj.serializers.ObjectSerializer

Deserialize an object from the format that the implementation requires to Java Object.

deserialize(String) - Method in class net.sf.serfj.serializers.XmlSerializer

Deserializes a XML (default XStream representation) representation of an object.

DoNotRenderPage - Annotation Type in net.sf.serfj.annotations

With this runtime annotation, a developer is able to mark a controller's method in order to not render a page after its execution.

It's only valid to methods that return void, because methods that return an object, will always serialize that object in the response.

Methods that don't return anything have to be annotated so the framework is able to know what to do after the execution.

doResponse() - Method in class net.sf.serfj.ResponseHelper

F

FileSerializer - Class in net.sf.serfj.serializers

Serializer for files.

FileSerializers write a file to an OutputStream.

Generally this class is used to write files to the ServletOutputStream of HttpServletResponse in order to send files to the client.

FileSerializer() - Constructor for class net.sf.serfj.serializers.FileSerializer

findByFunction(String) - Method in class net.sf.serfj.finders.ResourceFinder

findByFunctionAndModel(String) - Method in class net.sf.serfj.finders.ResourceFinder

findByModel(String) - Method in class net.sf.serfj.finders.ResourceFinder

findResource(String) - Method in class net.sf.serfj.finders.ResourceFinder

forward() - Method in class net.sf.serfj.ResponseHelper

G

GET - Annotation Type in net.sf.serfj.annotations

Annotation used to mark a resource method that responds to HTTP GET requests.

getBoolean(ConfigParam) - Method in class net.sf.serfj.config.SystemConfig

Devuelve el valor del parametro como un Boolean.

getConfigFilePath() - Method in class net.sf.serfj.config.SystemConfig

Devuelve la ruta del fichero de configuracion.

getContentTransferEncoding() - Method in class net.sf.serfj.serializers.Base64Serializer

Returns 'base64' as content-transfer-encoding.

getContentType() - Method in class net.sf.serfj.serializers.Base64Serializer

getContentType() - Method in class net.sf.serfj.serializers.FileSerializer

Content type that will be used in the response.

getContentType() - Method in class net.sf.serfj.serializers.JsonSerializer

Returns "application/json" content-type.

getContentType() - Method in interface net.sf.serfj.serializers.Serializer

Content type that will be used in the response.

getContentType() - Method in class net.sf.serfj.serializers.XmlSerializer

Returns "text/xml" content-type.

getContext() - Method in class net.sf.serfj.ResponseHelper

Gets ServletContext object related to this request.

getDefaultValue() - Method in class net.sf.serfj.config.ConfigParam

Obtiene el valor por defecto del parametro.

getExtension(String) - Static method in class net.sf.serfj.finders.SerializerFinder

Returns a extension from a content-type.

getExtension() - Method in class net.sf.serfj.ResponseHelper

Gets the URL extension, if any.

getExtension() - Method in class net.sf.serfj.RestController

Gets the URL extension, if any.

getExtension(String) - Method in class net.sf.serfj.util.UrlUtils

Gets the extension used in the URL, if any.

getId() - Method in class net.sf.serfj.ResponseHelper

Gets the value of an Id for the current resource.

/sessions/1 -> Id: 1, identifier of 'session'
/sessions/1/users/2 -> Id: 2, identifier of 'users'

getId(String) - Method in class net.sf.serfj.ResponseHelper

Gets the value of an Id given its resource's name.

/sessions/1 -> Id: 1, Resource: session
/sessions/1/users/2 -> Id: 2, Resource: user

getId() - Method in class net.sf.serfj.RestController

Gets the value of an Id for the current resource.

/sessions/1 -> Id: 1, identifier of 'session'
/sessions/1/users/2 -> Id: 2, identifier of 'users'

getId(String) - Method in class net.sf.serfj.RestController

Gets the value of an Id given its resource's name.

/sessions/1 -> Id: 1, Resource: session
/sessions/1/users/2 -> Id: 2, Resource: user

getInstance() - Static method in class net.sf.serfj.util.UrlUtils

Returns the unique instance of this class.

getInt(ConfigParam) - Method in class net.sf.serfj.config.SystemConfig

Devuelve el valor del parametro como un int.

getLong(ConfigParam) - Method in class net.sf.serfj.config.SystemConfig

Devuelve el valor del parametro como un Long.

getName() - Method in class net.sf.serfj.config.ConfigParam

Obtiene el identificador del parametro.

getParam(String) - Method in class net.sf.serfj.ResponseHelper

Gets a the value of a parameter that came in the URL or in the request.

getParam(String) - Method in class net.sf.serfj.RestController

Gets a the value of a parameter that came in the URL or in the request.

getParams() - Method in class net.sf.serfj.ResponseHelper

Gets a Map containing all the parameters in the query string, and all the attributes in the request.

getParams() - Method in class net.sf.serfj.RestController

Gets a Map containing all the parameters in the query string, and all the attributes in the request.

getPrefix() - Method in class net.sf.serfj.finders.ResourceFinder

getRemoteAddress() - Method in class net.sf.serfj.RestController

Returns the remote address with including protocol.

getRequest(String, Map<String, String>) - Method in class net.sf.serfj.client.Client

Do a GET HTTP request to the given REST-URL.

getRequest() - Method in class net.sf.serfj.ResponseHelper

Gets HttpServletRequest object related to this request.

getResponse() - Method in class net.sf.serfj.ResponseHelper

Gets HttpServletResponse object related to this request.

getResponseHelper() - Method in class net.sf.serfj.RestController

Gets the ResponseHelper associated to the request.
When a controller's action is called, a ResponseHelper is set through RestController.setResponseHelper(ResponseHelper response)
so the action method will be able to access objects like HttpServletResponse, ServletContext and HttpServletRequest.

getSerializer() - Method in class net.sf.serfj.ResponseHelper

Gets the Serializer class, if any.

getSerializer() - Method in class net.sf.serfj.RestController

Gets the Serializer class, if any.

getStatus() - Method in exception net.sf.serfj.client.WebServiceException

Get the exception's status.

getString(ConfigParam) - Method in class net.sf.serfj.config.SystemConfig

Devuelve el valor del parametro como un String.

getStringParam(String) - Method in class net.sf.serfj.RestController

Returns parameter's value that is a String.

getUtils() - Method in class net.sf.serfj.finders.ResourceFinder

getValue(ConfigParam) - Method in class net.sf.serfj.config.SystemConfig

Devuelve el valor del parametro de configuracion que se recibe.

H

HttpMethod - Enum in net.sf.serfj

Represents the possible HTTP request methods.

I

init() - Method in class net.sf.serfj.RestServlet

Reads configuration from /serfj.properties.

isIdentifier(String) - Method in class net.sf.serfj.util.UrlUtils

Checks if an element of the URL is an identifier.

J

JsonSerializer - Class in net.sf.serfj.serializers

Default Json serializer/deserializer.

JsonSerializer() - Constructor for class net.sf.serfj.serializers.JsonSerializer

M

MAIN_PACKAGE - Static variable in class net.sf.serfj.Config

Java main package where the source is located.

makeClassName(String) - Method in class net.sf.serfj.finders.ResourceFinder

makeClassName() - Method in class net.sf.serfj.finders.ResourceFinder

N

net.sf.serfj - package net.sf.serfj

net.sf.serfj.annotations - package net.sf.serfj.annotations

net.sf.serfj.client - package net.sf.serfj.client

net.sf.serfj.config - package net.sf.serfj.config

net.sf.serfj.finders - package net.sf.serfj.finders

net.sf.serfj.serializers - package net.sf.serfj.serializers

net.sf.serfj.util - package net.sf.serfj.util

notRenderPage(Method) - Method in class net.sf.serfj.ResponseHelper

If the method is annotated with DoNotRenderPage, marks the response as not to render any page.

O

ObjectSerializer - Interface in net.sf.serfj.serializers

Interface for objects Serializers.

ObjectSerializers are serializers which serialize an Object to String and deserialize from String to an Object.

OFF_OPTION - Static variable in class net.sf.serfj.finders.ResourceFinder

P

PACKAGES_STYLE - Static variable in class net.sf.serfj.Config

Packages style.

POST - Annotation Type in net.sf.serfj.annotations

Annotation used to mark a resource method that responds to HTTP POST requests.

postRequest(String, Map<String, String>) - Method in class net.sf.serfj.client.Client

Do a POST HTTP request to the given REST-URL.

PUT - Annotation Type in net.sf.serfj.annotations

Annotation used to mark a resource method that responds to HTTP PUT requests.

putParam(String, Object) - Method in class net.sf.serfj.RestController

Adds an object to the request.

putRequest(String, Map<String, String>) - Method in class net.sf.serfj.client.Client

Do a PUT HTTP request to the given REST-URL.

R

removeQueryString(String) - Method in class net.sf.serfj.util.UrlUtils

Removes every character after '?'.

renderPage() - Method in class net.sf.serfj.ResponseHelper

Renders the predefined page.

renderPage(String) - Method in class net.sf.serfj.ResponseHelper

Renders some page within 'views' directory.

renderPage(String, String) - Method in class net.sf.serfj.ResponseHelper

Renders a page from a resource.

renderPage() - Method in class net.sf.serfj.RestController

Renders the predefined page.

renderPage(String) - Method in class net.sf.serfj.RestController

Renders some page within 'views' directory.

renderPage(String, String) - Method in class net.sf.serfj.RestController

Renders a page from a resource.

ResourceFinder - Class in net.sf.serfj.finders

This class is used to find some classes like controllers or serializers.

ResourceFinder(String, String, String, String) - Constructor for class net.sf.serfj.finders.ResourceFinder

ResponseHelper - Class in net.sf.serfj

This class allows the developer to render the predefined page for an action, or to render the page she wants, or serialize an object to JSon, XML, or whatever as a response.

ResponseHelper(ServletContext, HttpServletRequest, HttpServletResponse, UrlInfo, String) - Constructor for class net.sf.serfj.ResponseHelper

Constructor.

RestController - Class in net.sf.serfj

Class that can be used as parent class for an action which wants to be a Serfj controller.

RestController() - Constructor for class net.sf.serfj.RestController

RestController(ResponseHelper) - Constructor for class net.sf.serfj.RestController

RestServlet - Class in net.sf.serfj

Main class.

RestServlet() - Constructor for class net.sf.serfj.RestServlet

S

sendFile() - Method in class net.sf.serfj.ResponseHelper

sendFile(File, OutputStream) - Method in class net.sf.serfj.serializers.FileSerializer

Write a file to an OuputStream.

serialize(Object) - Method in class net.sf.serfj.ResponseHelper

Serialize an object.

serialize() - Method in class net.sf.serfj.ResponseHelper

serialize(Object) - Method in class net.sf.serfj.RestController

Serialize an object.

serialize(Object) - Method in class net.sf.serfj.serializers.Base64Serializer

Serialize object to an encoded base64 string.

serialize(Object) - Method in class net.sf.serfj.serializers.JsonSerializer

Serializes an object to Json.

serialize(Object) - Method in interface net.sf.serfj.serializers.ObjectSerializer

Serialize an object in the format that the implementation requires.

serialize(Object) - Method in class net.sf.serfj.serializers.XmlSerializer

Serializes an object to XML using the default XStream converter.

Serializer - Interface in net.sf.serfj.serializers

Interface for Serializers.

SerializerFinder - Class in net.sf.serfj.finders

Finds a serializer for a request.

SerializerFinder(String) - Constructor for class net.sf.serfj.finders.SerializerFinder

SerializerFinder(Config, String) - Constructor for class net.sf.serfj.finders.SerializerFinder

service(HttpServletRequest, HttpServletResponse) - Method in class net.sf.serfj.RestServlet

Parses the request to get information about what controller is trying to call, then invoke the action from that controller (if any), and finally gives an answer.

Basically it only dispatchs the request to a controller.

ServletHelper - Class in net.sf.serfj

Helper for RestServlet.

ServletHelper() - Constructor for class net.sf.serfj.ServletHelper

setAttachmentFilename(String) - Method in class net.sf.serfj.ResponseHelper

Sets the filename for the file that will be sent.

setContentType(String) - Method in class net.sf.serfj.ResponseHelper

Sets the contentType in case there isn't another FileSerializer implementation.

setFile(File) - Method in class net.sf.serfj.ResponseHelper

Sets the file to send to the client.

setFile(File, String, String) - Method in class net.sf.serfj.ResponseHelper

Sets the file to send to the client.

setResponseHelper(ResponseHelper) - Method in class net.sf.serfj.RestController

singularize(String) - Method in class net.sf.serfj.util.UrlUtils

Gets the singular of a plural.

SUFFIX_CONTROLLER - Static variable in class net.sf.serfj.Config

Suffix used for controller classes

SUFFIX_SERIALIZER - Static variable in class net.sf.serfj.Config

Suffix used for serializer classes

SystemConfig - Class in net.sf.serfj.config

Lee la configuración de un sistema.

SystemConfig(String) - Constructor for class net.sf.serfj.config.SystemConfig

Constructor.

T

toString() - Method in class net.sf.serfj.config.SystemConfig

Configuracion de la aplicacion.

U

UrlUtils - Class in net.sf.serfj.util

Utilidades para tratamiento de la url y de la información que viene en ella.

V

valueOf(String) - Static method in enum net.sf.serfj.HttpMethod

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.sf.serfj.HttpMethod

Returns an array containing the constants of this enum type, in the order they are declared.

VIEWS_DIRECTORY - Static variable in class net.sf.serfj.Config

Directory where the views will be located.

W

WebServiceException - Exception in net.sf.serfj.client

Exception that encapsulates exceptions thrown by controller's methods.

WebServiceException() - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

WebServiceException(String, Throwable) - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

WebServiceException(String) - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

WebServiceException(Throwable) - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

WebServiceException(int) - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

WebServiceException(String, Throwable, int) - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

WebServiceException(String, int) - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

WebServiceException(Throwable, int) - Constructor for exception net.sf.serfj.client.WebServiceException

Constructor.

writeFile(FileSerializer) - Method in class net.sf.serfj.ResponseHelper

writeObject(String, String) - Method in class net.sf.serfj.ResponseHelper

X

XmlSerializer - Class in net.sf.serfj.serializers

Default XML serializer/deserializer.

XmlSerializer() - Constructor for class net.sf.serfj.serializers.XmlSerializer

A B C D F G H I J M N O P R S T U V W X