WebScope (Bridje Web 0.5.0-beta6 API)

java.lang.Object
- org.bridje.web.WebScope

All Implemented Interfaces:

ContextListener<Object>, Scope
```
public final class WebScope
extends Object
implements Scope
```
Represents the IoC scope for the web request IocContext.

Constructor Summary

Constructors
Constructor and Description

WebScope(HttpBridletContext ctx)
The only constructor for this object, the HTTP bridlet context for the request mus be provided.

Constructors
Constructor and Description
`WebScope(HttpBridletContext ctx)` The only constructor for this object, the HTTP bridlet context for the request mus be provided.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpCookie`	`addCookie(String name, String value)` Adds a cookie to the HTTP response.
`String`	`getAccept()` The Accept header sent by the client.
`String`	`getContentType()` The mime/type sent by the client for this request, this method will get the Content-Type HTTP header.
`HttpCookie`	`getCookie(String name)` Gets the specified HTTP cookie.
`Map<String,HttpCookie>`	`getCookies()` Gets a map with all the cookies sent to the server by the client.
`String[]`	`getCookiesNames()` Gets all the cookies names available in this request.
`HttpReqParam`	`getGetParameter(String parameter)` Gets the specific "GET" parameter from the parameters map.
`Map<String,HttpReqParam>`	`getGetParameters()` Gets the "GET" parameters that where sent by the client in the query string of the request.
`String[]`	`getGetParametersNames()` Gets all the "GET" parameters names for this request if any.
`String`	`getHeader(String header)` Gets the value of the given header.
`String`	`getHost()` The host of the server the client made the HTTP request to
`IocContext<WebScope>`	`getIocContext()` The IoC context for this web request.
`String`	`getMethod()` The HTTP method used to made the request.
`String`	`getOrigPath()` The requested path asked by the client.
`String`	`getPath()` The current requested path, this method finds a ReqPathRef instance if any and retrieve the path specified there, if no instance is available it returns the requested path.
`HttpReqParam`	`getPostParameter(String parameter)` Gets the specific post parameter from the parameters map.
`Map<String,HttpReqParam>`	`getPostParameters()` Gets a unmodificable map to the post parameters sent by the client.
`String[]`	`getPostParametersNames()` Gets all the post parameters names for this request if any.
`String`	`getProtocol()` The protocol used to made the request
`WebSession`	`getSession()` Gets the current WebSession for this HTTP request.
`String`	`getStateValue(String name)`
`String`	`getUserAgent()` The UserAgent heather from the HTTP request if any.
`boolean`	`isDelete()` When ever this request is http method is "DELETE".
`boolean`	`isGet()` When ever this request is HTTP method is "GET".
`boolean`	`isPatch()` When ever this request is HTTP method is "PATCH".
`boolean`	`isPost()` When ever this request is HTTP method is "POST".
`boolean`	`isPut()` When ever this request is HTTP method is "PUT".
`void`	`postInitComponent(Class<Object> clazz, Object instance)`
`void`	`preCreateComponent(Class<Object> clazz)`
`void`	`preInitComponent(Class<Object> clazz, Object instance)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebScope
```
public WebScope(HttpBridletContext ctx)
```
    The only constructor for this object, the HTTP bridlet context for the request mus be provided.
    
    Parameters:
    
    ctx - The HTTP bridlet context for the current HTTP request.
- Method Detail
  - getIocContext
```
public IocContext<WebScope> getIocContext()
```
    The IoC context for this web request.
    
    Returns:
    
    The instance of IocContext created for this HTTP request.
  - getMethod
```
public String getMethod()
```
    The HTTP method used to made the request.
    
    Returns:
    
    An String representing the HTTP method used to made the request.
  - getProtocol
```
public String getProtocol()
```
    The protocol used to made the request
    
    Returns:
    
    An String representing the protocol used to made the request
  - getHost
```
public String getHost()
```
    The host of the server the client made the HTTP request to
    
    Returns:
    
    An String representing the host name of the server.
  - getUserAgent
```
public String getUserAgent()
```
    The UserAgent heather from the HTTP request if any.
    
    Returns:
    
    An String representing the UserAgent information from the client if is available.
  - getAccept
```
public String getAccept()
```
    The Accept header sent by the client.
    
    Returns:
    
    An String representing the value of the Accept header
  - getPath
```
public String getPath()
```
    The current requested path, this method finds a ReqPathRef instance if any and retrieve the path specified there, if no instance is available it returns the requested path.
    
    Returns:
    
    An String representing the requested path asked by the client.
  - getOrigPath
```
public String getOrigPath()
```
    The requested path asked by the client.
    
    Returns:
    
    An String representing the requested path asked by the client.
  - getContentType
```
public String getContentType()
```
    The mime/type sent by the client for this request, this method will get the Content-Type HTTP header.
    
    Returns:
    
    The mime/type sent by the client for this request.
  - isGet
```
public boolean isGet()
```
    When ever this request is HTTP method is "GET".
    
    Returns:
    
    true the HTTP method for this request is "GET", false otherwise.
  - isPost
```
public boolean isPost()
```
    When ever this request is HTTP method is "POST".
    
    Returns:
    
    true the HTTP method for this request is "GET", false otherwise.
  - isDelete
```
public boolean isDelete()
```
    When ever this request is http method is "DELETE".
    
    Returns:
    
    true the http method for this request is "DELETE", false otherwise.
  - isPut
```
public boolean isPut()
```
    When ever this request is HTTP method is "PUT".
    
    Returns:
    
    true the HTTP method for this request is "PUT", false otherwise.
  - isPatch
```
public boolean isPatch()
```
    When ever this request is HTTP method is "PATCH".
    
    Returns:
    
    true the HTTP method for this request is "PATCH", false otherwise.
  - getHeader
```
public String getHeader(String header)
```
    Gets the value of the given header.
    
    Parameters:
    
    header - The header's name.
    
    Returns:
    
    The value of the header.
  - getPostParameters
```
public Map<String,HttpReqParam> getPostParameters()
```
    Gets a unmodificable map to the post parameters sent by the client. If this request is not a "application/x-www-form-urlencoded" or a multipart/form-data" the post parameters map will be empty.
    
    Returns:
    
    A map with all the post parameters sent by the client.
  - getPostParameter
```
public HttpReqParam getPostParameter(String parameter)
```
    Gets the specific post parameter from the parameters map.
    
    Parameters:
    
    parameter - The post parameter name.
    
    Returns:
    
    The post parameter value or null if it does not exists.
  - getPostParametersNames
```
public String[] getPostParametersNames()
```
    Gets all the post parameters names for this request if any.
    
    Returns:
    
    An array of String representing all the post parameters for this request.
  - getGetParameters
```
public Map<String,HttpReqParam> getGetParameters()
```
    Gets the "GET" parameters that where sent by the client in the query string of the request.
    
    Returns:
    
    A map with all the "GET" parameters for this request.
  - getGetParameter
```
public HttpReqParam getGetParameter(String parameter)
```
    Gets the specific "GET" parameter from the parameters map.
    
    Parameters:
    
    parameter - The "GET" parameter name.
    
    Returns:
    
    The "GET" parameter value or null if it does not exists.
  - getGetParametersNames
```
public String[] getGetParametersNames()
```
    Gets all the "GET" parameters names for this request if any.
    
    Returns:
    
    An array of String representing all the "GET" parameters for this request.
  - getCookies
```
public Map<String,HttpCookie> getCookies()
```
    Gets a map with all the cookies sent to the server by the client.
    
    Returns:
    
    A map with the HTTP cookies for this request.
  - getCookie
```
public HttpCookie getCookie(String name)
```
    Gets the specified HTTP cookie.
    
    Parameters:
    
    name - The name of the HTTP Cookie.
    
    Returns:
    
    the HttpCookie object representing the cookie or null if it does not exists.
  - addCookie
```
public HttpCookie addCookie(String name,
                            String value)
```
    Adds a cookie to the HTTP response.
    
    Parameters:
    
    name - The name of the HTTP Cookie.
    
    value - The value of the HTTP Cookie.
    
    Returns:
    
    The HTTP Cookie added.
  - getCookiesNames
```
public String[] getCookiesNames()
```
    Gets all the cookies names available in this request.
    
    Returns:
    
    An array of String representing the cookies names.
  - preCreateComponent
```
public void preCreateComponent(Class<Object> clazz)
```
    Specified by:
    
    preCreateComponent in interface ContextListener<Object>
  - preInitComponent
```
public void preInitComponent(Class<Object> clazz,
                             Object instance)
```
    Specified by:
    
    preInitComponent in interface ContextListener<Object>
  - postInitComponent
```
public void postInitComponent(Class<Object> clazz,
                              Object instance)
```
    Specified by:
    
    postInitComponent in interface ContextListener<Object>
  - getSession
```
public WebSession getSession()
```
    Gets the current WebSession for this HTTP request.
    
    Returns:
    
    The current WebSession for this HTTP request.
  - getStateValue
```
public String getStateValue(String name)
```

Class WebScope

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebScope

Method Detail

getIocContext

getMethod

getProtocol

getHost

getUserAgent

getAccept

getPath

getOrigPath

getContentType

isGet

isPost

isDelete

isPut

isPatch

getHeader

getPostParameters

getPostParameter

getPostParametersNames

getGetParameters

getGetParameter

getGetParametersNames

getCookies

getCookie

addCookie

getCookiesNames

preCreateComponent

preInitComponent

postInitComponent

getSession

getStateValue