|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.workflow.portlet.client.ResponsePage
Objects of this class represent the responses sent by the Web Client.
They are created by the various commandResponse
methods of a
Viewer
.
To return a static HTML page use
return ResponsePage(context, "/static.html");
Field Summary | |
---|---|
static java.lang.String |
MIMETYPE_HTML
Constant for text/html |
static java.lang.String |
MIMETYPE_JPEG
Constant for image/jpeg |
static java.lang.String |
MIMETYPE_WML
Constant for text/vnd.wap.wml |
static java.lang.String |
MIMETYPE_XML
Constant for text/xml |
Constructor Summary | |
---|---|
ResponsePage(byte[] contents,
java.lang.String mimeType)
Create a response page from a byte array. |
|
ResponsePage(byte[] contents,
java.lang.String mimeType,
boolean followOnPageIsShown)
Create a response page from a byte array. |
|
ResponsePage(byte[] contents,
java.lang.String mimeType,
long date)
Create a response page from a byte array. |
|
ResponsePage(byte[] contents,
java.lang.String mimeType,
long date,
boolean followOnPageIsShown)
Create a response page from a byte array. |
|
ResponsePage(int status)
Create a response page from an HTTP status code. |
|
ResponsePage(int status,
boolean followOnPageIsShown)
Create a response page from an HTTP status code. |
|
ResponsePage(RequestContext context,
java.lang.String urlname)
Create a response page from a URL. |
|
ResponsePage(RequestContext context,
java.lang.String urlname,
boolean followOnPageIsShown)
Create a response page from a URL. |
|
ResponsePage(RequestContext context,
java.lang.String urlname,
long date)
Create a response page from a URL. |
|
ResponsePage(RequestContext context,
java.lang.String urlname,
long date,
boolean followOnPageIsShown)
Create a response page from a URL. |
|
ResponsePage(java.lang.StringBuffer contents)
Create a response page from a StringBuffer. |
|
ResponsePage(java.lang.StringBuffer contents,
boolean followOnPageIsShown)
Create a response page from a StringBuffer. |
|
ResponsePage(java.lang.StringBuffer contents,
java.lang.String mimeType)
Create a response page from a StringBuffer. |
|
ResponsePage(java.lang.StringBuffer contents,
java.lang.String mimeType,
boolean followOnPageIsShown)
Create a response page from a StringBuffer. |
|
ResponsePage(java.lang.StringBuffer contents,
java.lang.String mimeType,
long date)
Create a response page from a StringBuffer. |
|
ResponsePage(java.lang.StringBuffer contents,
java.lang.String mimeType,
long date,
boolean followOnPageIsShown)
Create a response page from a StringBuffer. |
Method Summary | |
---|---|
boolean |
isFollowOnPageShown()
Return flag indication whether a nontrivial page is shown. |
void |
setExpiryDate(long time)
Set the expiry date of the reponse page. |
void |
setFollowOnPageShown(boolean isFollowOnPageShown)
Set flag for the Portal Client which indicates that a nontrivial page will be shown. |
void |
setMimeType(java.lang.String mimeType)
Set the MIME type of the reponse page. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String MIMETYPE_HTML
text/html
public static final java.lang.String MIMETYPE_XML
text/xml
public static final java.lang.String MIMETYPE_WML
text/vnd.wap.wml
public static final java.lang.String MIMETYPE_JPEG
image/jpeg
Constructor Detail |
public ResponsePage(int status)
status
- The HTTP status code to send.public ResponsePage(int status, boolean followOnPageIsShown)
status
- The HTTP status code to send.followOnPageIsShown
- True if nontrivial page is shownpublic ResponsePage(java.lang.StringBuffer contents)
contents
- The buffer containing the response.public ResponsePage(java.lang.StringBuffer contents, boolean followOnPageIsShown)
contents
- The buffer containing the response.followOnPageIsShown
- True if nontrivial page is shownpublic ResponsePage(java.lang.StringBuffer contents, java.lang.String mimeType)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.public ResponsePage(java.lang.StringBuffer contents, java.lang.String mimeType, boolean followOnPageIsShown)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.followOnPageIsShown
- True if nontrivial page is shownpublic ResponsePage(java.lang.StringBuffer contents, java.lang.String mimeType, long date)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.date
- The expiry date of the pagepublic ResponsePage(java.lang.StringBuffer contents, java.lang.String mimeType, long date, boolean followOnPageIsShown)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.date
- The expiry date of the pagefollowOnPageIsShown
- True if nontrivial page is shownpublic ResponsePage(byte[] contents, java.lang.String mimeType)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.public ResponsePage(byte[] contents, java.lang.String mimeType, boolean followOnPageIsShown)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.followOnPageIsShown
- True if nontrivial page is shownpublic ResponsePage(byte[] contents, java.lang.String mimeType, long date)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.date
- The expiry date of the pagepublic ResponsePage(byte[] contents, java.lang.String mimeType, long date, boolean followOnPageIsShown)
contents
- The buffer containing the response.mimeType
- The MIME type of the response.date
- The expiry date of the pagefollowOnPageIsShown
- True if nontrivial page is shownpublic ResponsePage(RequestContext context, java.lang.String urlname)
context
passed as parameter can then be accessed in the JSP using the following
code:
<jsp:useBean id="context" scope="request" type="com.ibm.workflow.servlet.client.RequestContext"/>
context
- The context that was passed to the Viewer's
commandResponse
method. If null
, the
servlet will not directly invoke the page but rather send an HTTP
redirect (status code 302) response.urlname
- The relative URL of the page to be sent as response. This
can be either an HTML page or a JSP.public ResponsePage(RequestContext context, java.lang.String urlname, boolean followOnPageIsShown)
context
passed as parameter can then be accessed in the JSP using the following
code:
<jsp:useBean id="context" scope="request" type="com.ibm.workflow.servlet.client.RequestContext"/>
context
- The context that was passed to the Viewer's
commandResponse
method. If null
, the
servlet will not directly invoke the page but rather send an HTTP
redirect (status code 302) response.urlname
- The relative URL of the page to be sent as response. This
can be either an HTML page or a JSP.followOnPageIsShown
- True if nontrivial page is shownpublic ResponsePage(RequestContext context, java.lang.String urlname, long date)
context
passed as parameter can then be accessed in the JSP using the following
code:
<jsp:useBean id="context" scope="request" type="com.ibm.workflow.servlet.client.RequestContext"/>
context
- The context that was passed to the Viewer's
commandResponse
method. If null
, the
servlet will not directly invoke the page but rather send an HTTP
redirect (status code 302) response.urlname
- The relative URL of the page to be sent as response. This
can be either an HTML page or a JSP.date
- The expiry date of the pagepublic ResponsePage(RequestContext context, java.lang.String urlname, long date, boolean followOnPageIsShown)
context
passed as parameter can then be accessed in the JSP using the following
code:
<jsp:useBean id="context" scope="request" type="com.ibm.workflow.servlet.client.RequestContext"/>
context
- The context that was passed to the Viewer's
commandResponse
method. If null
, the
servlet will not directly invoke the page but rather send an HTTP
redirect (status code 302) response.urlname
- The relative URL of the page to be sent as response. This
can be either an HTML page or a JSP.date
- The expiry date of the pagefollowOnPageIsShown
- True if nontrivial page is shownMethod Detail |
public void setMimeType(java.lang.String mimeType)
mimeType
- The MIME type of the response page.public void setExpiryDate(long time)
date
- The expiry date of the pagepublic void setFollowOnPageShown(boolean isFollowOnPageShown)
isFollowOnPageShown
- Whether a nontrivial page is shownpublic boolean isFollowOnPageShown()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |