Method Summary |
|
abstract public void | addProperty(String name, String value) Add a value to a property to be returned to the client. |
abstract public boolean | canGuaranteeConfidentiality() Return true if the connection can guarantee confidentiality (preventing
reading while in transit). |
abstract public boolean | canGuaranteeIntegrity() Return true if the connection can guarantee integrity
(preventing data tampering in the communication process). |
public void | checkForFailure() Throw an exception if an error was encountered when using this conneciton. |
abstract public String | encodeURL(String path) Encode a url with any special encoding needed by the protocol,
for example by adding a sesison id. |
public void | finish() |
abstract public void | flushBuffer() |
public static Action | getAction(PortletRequest portletRequest) Return the Action that corresponds to the PortletRequest, or null
if there is not a current Action or Connection. |
public Action | getAction(Window window, String namespace) Get an Action for a namespace. |
abstract public Object | getAttribute(String name) Get an attribute for the current connection. |
abstract public Enumeration | getAttributeNames() Get a list of all attributes for the current connection. |
abstract public String | getAuthType() Return the authentication scheme used for the current request. |
abstract public int | getBufferSize() |
abstract public String | getCharacterEncoding() |
abstract public Set<String> | getClientCharacterEncodings() Get the character encodings acceptable to the client. |
abstract public Set<String> | getClientContentTypes() Get the content types acceptable to the client. |
abstract public Set<Locale> | getClientLocales() Get the locales acceptable to the client. |
public static PortletConnection | getConnection(PortletRequest portletRequest) |
abstract public String | getContentType() Return the content type established with setContentType(), or null if
setContentType() has not been called. |
abstract public String | getContextPath() Return the path to the portal portion of the url that was used to make the
request. |
public Action | getCurrentAction() Get the current Action object, established from a call to getRender(). |
public Render | getCurrentRender() Get the current Render object, established from a call to getRender(). |
protected int | getExpirationCache() Used in derived classes during finish() to determine
the maximum expires time for the connection, derived classes use this
value to send an expires timeout to the client. |
public String | getId() |
abstract public Locale | getLocale() Return the Locale established with setLocale(), or null if setLocale()
has not been called. |
abstract public OutputStream | getOutputStream() |
public static Portal | getPortal(PortletRequest portletRequest) Return the Portal that corresponds to the PortletRequest, or null
if there is not a current Portal or Connection. |
public Portal | getPortal() |
abstract public PortletSession | getPortletSession(boolean create) Return a
PortletSession for the current client, or null if one is
not available.
A PortletSession once established will be consistently returned for a
client on subsequent requests. |
abstract public Enumeration | getProperties(String propertyName) Return the values of the specified connection property as an array of
Strings, null if the property was not provided by the request from the
client. |
abstract public String | getProperty(String propertyName) Return the value of the specified connection property as a String, null
if the property was not provided by the request from the client. |
abstract public Enumeration | getPropertyNames() Return the names of available properties for the connection. |
abstract public String | getRemoteUser() Return the identity of the remote user, null if the identity has not been
established. |
public static Render | getRender(PortletRequest portletRequest) Return the Render that corresponds to the PortletRequest, or null
if there is not a current Render or Connection. |
public Render | getRender(Window window, String namespace) Get a Render for a namespace. |
abstract public String | getRequestedSessionId() Return the session id that was supplied by the client for the current
request. |
abstract public String | getScheme() Return the scheme portion of the url that was used to make the request. |
abstract public String | getServerName() Return the host name portion of the url that was used to make the request. |
abstract public int | getServerPort() Return the port portion of the url that was used to make the request. |
abstract public String | getSubmitCharacterEncoding() Return the name of the character encoding that will be used by the Reader
obtained using
PortletConnection.getReader , null if none. |
abstract public int | getSubmitContentLength() Return the length of of the data supplied as the "body" of the request,
-1 if not known. |
abstract public String | getSubmitContentType() Return the MIME type of the data supplied as the "body" of the request,
null if not known. |
abstract public InputStream | getSubmitInputStream() Return the binary body of the current request. |
abstract public BufferedReader | getSubmitReader() |
abstract public Principal | getUserPrincipal() Return a
java.security.Principal that contains the identity of
the remote user, null if the identity has not been established. |
abstract public PrintWriter | getWriter() |
abstract public boolean | handleConstraintFailure(Constraint constraint, int failureCode) Handle a constraint failure by sending some response to the client.
false if the connection cannot handle the constraint failure. |
abstract public boolean | handleException(Exception exception) Handle an exception by sending some response to the client.
false if the connection cannot handle the constraint failure. |
abstract public boolean | isCommitted() |
public boolean | isConnectionFailed() A connection fails if an unrecoverable error occurs. |
protected boolean | isPrivate() |
abstract public boolean | isRequestedSessionIdValid() Return true the session id that was supplied by the client for the current
request is valid. |
abstract public boolean | isSecure() Return true if the connection for the current request is secure, for
example it uses HTTPS. |
abstract public boolean | isUserInRole(String role) Return true if the identity of remote user has been established and the
user has been assigned the role. |
abstract public void | removeAttribute(String name) Remove an attribute for the current connection. |
abstract public void | reset() |
abstract public void | resetBuffer() |
abstract public String | resolveURL(String partialUrl) |
abstract public String | resolveURL(String partialUrl, boolean isSecure) Resolve a url so that it makes a request to the portal with
the specified level of security. |
abstract public void | sendRedirect(String location) |
abstract public void | setAttribute(String name, Object o) Set an attribute for the current connection. |
abstract public void | setBufferSize(int size) |
abstract public void | setCharacterEncoding(String enc) |
public void | setConnectionFailed() Used to indicate that the connection has failed. |
public void | setConnectionFailed(Exception ex) Used to indicate that the connection has failed. |
abstract public void | setContentType(String contentType) Set the content type to use for the response. |
abstract public void | setLocale(Locale locale) Set the locale to use for the response. |
abstract public void | setProperty(String name, String value) Set a property to be returned to the client. |
abstract public void | setSubmitCharacterEncoding(String enc) Override the character encoding used by the Reader obtained
using
PortletConnection.getReader . |
public void | start(Portal portal, InvocationFactory invocationFactory) |