de.uplanet.lucy.server.connector

Interface IServerBridgeRequest

All Known Implementing Classes:

GroovyServerBridgeRequest

public interface IServerBridgeRequest

Version:

$Revision: 182292 $

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String p_strKey) Test if the request contains the specified variable.
IServerBridgeRequest	createCopy() Create a copy of the topmost state of this request.
java.lang.String	get(java.lang.String p_strKey) Get a request variable.
java.lang.String	get(java.lang.String p_strKey, java.lang.String p_strFallback) Get a request variable.
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	getEntrySet() Get an unmodifiable set that contains all request variables.
byte[]	getHttpBody() Deprecated. This method will be removed.
de.uplanet.lucy.server.connector.IUploadFiles	getUploadFiles() Get the files that were uploaded with this request.
boolean	hasUploadFiles() Check if files were uploaded with this request.
void	popVariables() Pop request variables from the stack.
void	pushVariables() Push request variables on the stack.
void	put(java.lang.String p_strKey, java.lang.String p_strValue) Set a request variable.
void	remove(java.lang.String p_strKey) Remove the specified variable from the request.
void	setHttpBody(byte[] p_buf) Deprecated. This method will be removed.
int	size()

Method Detail

get

java.lang.String get(java.lang.String p_strKey)

Get a request variable.

Parameters:

p_strKey - The key.

Returns:

The value that is referenced by p_strKey, or null if there is no such request variable.

get

java.lang.String get(java.lang.String p_strKey,
                     java.lang.String p_strFallback)

Get a request variable.

Parameters:

p_strKey - The key.

p_strFallback - The fallback value.

Returns:

The value that is referenced by p_strKey, or p_objFallback if there is no such request variable.

put

void put(java.lang.String p_strKey,
         java.lang.String p_strValue)

Set a request variable.

Parameters:

p_strKey - The name of the request variable.

p_strValue - The value of the request variable.

remove

void remove(java.lang.String p_strKey)

Remove the specified variable from the request.

Parameters:

p_strKey - The name of the variable to remove.

containsKey

boolean containsKey(java.lang.String p_strKey)

Test if the request contains the specified variable.

Parameters:

p_strKey - The name of the variable.

Returns:

true if the request contains the specified variable.

getEntrySet

java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> getEntrySet()

Get an unmodifiable set that contains all request variables.

Returns:

A set containing Map.Entrys that contain requests variable name-value-pairs.

pushVariables

void pushVariables()

Push request variables on the stack.

popVariables

void popVariables()

Pop request variables from the stack.

createCopy

IServerBridgeRequest createCopy()

Create a copy of the topmost state of this request.

The request created will have an empty stack.

Returns:

The copy.

size

int size()

Returns:

Returns the number of request parameters in this request.

getHttpBody

@Deprecated
byte[] getHttpBody()

Deprecated. This method will be removed.

Get the HTTP body of the request.

Note: A call to this method does not create a copy of the data but returns a reference to the data instead. For this reason the caller must not modify the array returned.

Returns:

The HTTP body data, or null if the data are not available.

setHttpBody

@Deprecated
void setHttpBody(byte[] p_buf)

Deprecated. This method will be removed.

Set the HTTP body of the request.

Parameters:

p_buf - The HTTP body data.

hasUploadFiles

boolean hasUploadFiles()

Check if files were uploaded with this request.

Returns:

true if files were uploaded with this request, or false otherwise.

getUploadFiles

de.uplanet.lucy.server.connector.IUploadFiles getUploadFiles()

Get the files that were uploaded with this request.

Returns:

The files that were uploaded with this request, or null.