<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.6.0) on Mon Oct 19 13:38:32 CDT 2009 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
RuntimeContext (Apache Wink 1.0-incubating API) | |
</TITLE> | |
<META NAME="date" CONTENT="2009-10-19"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="RuntimeContext (Apache Wink 1.0-incubating API)"; | |
} | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<HR> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RuntimeContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../org/apache/wink/common/RestException.html" title="class in org.apache.wink.common"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/wink/common/WinkApplication.html" title="class in org.apache.wink.common"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/wink/common/RuntimeContext.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="RuntimeContext.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.wink.common</FONT> | |
<BR> | |
Interface RuntimeContext</H2> | |
<DL> | |
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/wink/server/handlers/MessageContext.html" title="interface in org.apache.wink.server.handlers">MessageContext</A></DD> | |
</DL> | |
<HR> | |
<DL> | |
<DT><PRE>public interface <B>RuntimeContext</B></DL> | |
</PRE> | |
<P> | |
<HR> | |
<P> | |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> | |
<TR ALIGN="right" VALIGN=""> | |
<TD NOWRAP><FONT SIZE="-1"> | |
<CODE><T> T</CODE></FONT></TD> | |
</TR> | |
</TABLE> | |
</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getAttribute(java.lang.Class)">getAttribute</A></B>(java.lang.Class<T> type)</CODE> | |
<BR> | |
Convenience method for getting an attribute whose key that is the fully | |
qualified name of a class</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getAttributes()">getAttributes</A></B>()</CODE> | |
<BR> | |
Get an attributes map to store objects in the context of a request.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> javax.ws.rs.core.HttpHeaders</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getHttpHeaders()">getHttpHeaders</A></B>()</CODE> | |
<BR> | |
Get the <CODE>HttpHeaders</CODE> context</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.io.InputStream</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getInputStream()">getInputStream</A></B>()</CODE> | |
<BR> | |
Get the input stream of the request</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> java.io.OutputStream</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getOutputStream()">getOutputStream</A></B>()</CODE> | |
<BR> | |
Get the output stream of the response</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> javax.ws.rs.ext.Providers</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getProviders()">getProviders</A></B>()</CODE> | |
<BR> | |
Get the <CODE>Providers</CODE> context</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> javax.ws.rs.core.Request</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getRequest()">getRequest</A></B>()</CODE> | |
<BR> | |
Get the <CODE>Request</CODE> context</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> javax.ws.rs.core.SecurityContext</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getSecurityContext()">getSecurityContext</A></B>()</CODE> | |
<BR> | |
Get the <CODE>SecurityContext</CODE> context</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> javax.ws.rs.core.UriInfo</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#getUriInfo()">getUriInfo</A></B>()</CODE> | |
<BR> | |
Get the <CODE>UriInfo</CODE> context</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> | |
<TR ALIGN="right" VALIGN=""> | |
<TD NOWRAP><FONT SIZE="-1"> | |
<CODE><T> void</CODE></FONT></TD> | |
</TR> | |
</TABLE> | |
</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/wink/common/RuntimeContext.html#setAttribute(java.lang.Class, T)">setAttribute</A></B>(java.lang.Class<T> type, | |
T object)</CODE> | |
<BR> | |
Convenience method for setting an attribute whose key that is the fully | |
qualified name of a class</TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="getProviders()"><!-- --></A><H3> | |
getProviders</H3> | |
<PRE> | |
javax.ws.rs.ext.Providers <B>getProviders</B>()</PRE> | |
<DL> | |
<DD>Get the <CODE>Providers</CODE> context | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the <CODE>Providers</CODE> context</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getHttpHeaders()"><!-- --></A><H3> | |
getHttpHeaders</H3> | |
<PRE> | |
javax.ws.rs.core.HttpHeaders <B>getHttpHeaders</B>()</PRE> | |
<DL> | |
<DD>Get the <CODE>HttpHeaders</CODE> context | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the <CODE>HttpHeaders</CODE> context</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getUriInfo()"><!-- --></A><H3> | |
getUriInfo</H3> | |
<PRE> | |
javax.ws.rs.core.UriInfo <B>getUriInfo</B>()</PRE> | |
<DL> | |
<DD>Get the <CODE>UriInfo</CODE> context | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the <CODE>UriInfo</CODE> context</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSecurityContext()"><!-- --></A><H3> | |
getSecurityContext</H3> | |
<PRE> | |
javax.ws.rs.core.SecurityContext <B>getSecurityContext</B>()</PRE> | |
<DL> | |
<DD>Get the <CODE>SecurityContext</CODE> context | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the <CODE>SecurityContext</CODE> context</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRequest()"><!-- --></A><H3> | |
getRequest</H3> | |
<PRE> | |
javax.ws.rs.core.Request <B>getRequest</B>()</PRE> | |
<DL> | |
<DD>Get the <CODE>Request</CODE> context | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the <CODE>Request</CODE> context</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getInputStream()"><!-- --></A><H3> | |
getInputStream</H3> | |
<PRE> | |
java.io.InputStream <B>getInputStream</B>() | |
throws java.io.IOException</PRE> | |
<DL> | |
<DD>Get the input stream of the request | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the request input stream | |
<DT><B>Throws:</B> | |
<DD><CODE>java.io.IOException</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getOutputStream()"><!-- --></A><H3> | |
getOutputStream</H3> | |
<PRE> | |
java.io.OutputStream <B>getOutputStream</B>() | |
throws java.io.IOException</PRE> | |
<DL> | |
<DD>Get the output stream of the response | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the response output stream | |
<DT><B>Throws:</B> | |
<DD><CODE>java.io.IOException</CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getAttributes()"><!-- --></A><H3> | |
getAttributes</H3> | |
<PRE> | |
java.util.Map<java.lang.String,java.lang.Object> <B>getAttributes</B>()</PRE> | |
<DL> | |
<DD>Get an attributes map to store objects in the context of a request. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>a live map of attributes</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setAttribute(java.lang.Class,java.lang.Object)"><!-- --></A><A NAME="setAttribute(java.lang.Class, T)"><!-- --></A><H3> | |
setAttribute</H3> | |
<PRE> | |
<T> void <B>setAttribute</B>(java.lang.Class<T> type, | |
T object)</PRE> | |
<DL> | |
<DD>Convenience method for setting an attribute whose key that is the fully | |
qualified name of a class | |
<P> | |
<DD><DL> | |
<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - attribute type<DT><B>Parameters:</B><DD><CODE>type</CODE> - the class of the key whose fully qualified name is used as | |
the key<DD><CODE>object</CODE> - the object to set</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getAttribute(java.lang.Class)"><!-- --></A><H3> | |
getAttribute</H3> | |
<PRE> | |
<T> T <B>getAttribute</B>(java.lang.Class<T> type)</PRE> | |
<DL> | |
<DD>Convenience method for getting an attribute whose key that is the fully | |
qualified name of a class | |
<P> | |
<DD><DL> | |
<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - attribute type<DT><B>Parameters:</B><DD><CODE>type</CODE> - he class of the key whose fully qualified name is used as the | |
key | |
<DT><B>Returns:</B><DD>the attribute or null</DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RuntimeContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../org/apache/wink/common/RestException.html" title="class in org.apache.wink.common"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/wink/common/WinkApplication.html" title="class in org.apache.wink.common"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/wink/common/RuntimeContext.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="RuntimeContext.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright © 2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. | |
</BODY> | |
</HTML> |