| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| Client (Apache CXF Bundle Jar 2.6.3 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cxf.rs.security.oauth2.common.Client class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="Client (Apache CXF Bundle Jar 2.6.3 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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/Client.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="../../../../../../../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> |
| Apache CXF API</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenValidation.html" title="class in org.apache.cxf.rs.security.oauth2.common"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/common/Client.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Client.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.cxf.rs.security.oauth2.common</FONT> |
| <BR> |
| Class Client</H2> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cxf.rs.security.oauth2.common.Client</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>Client</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> |
| </PRE> |
| |
| <P> |
| Represents a registered third-party Client application |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#Client(java.lang.String, java.lang.String, boolean)">Client</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientId, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientSecret, |
| boolean isConfidential)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#Client(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String)">Client</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientId, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientSecret, |
| boolean isConfidential, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationName, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationWebUri)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getAllowedGrantTypes()">getAllowedGrantTypes</A></B>()</CODE> |
| |
| <BR> |
| Gets the list of access token grant types this client |
| can use to obtain the access tokens.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getApplicationDescription()">getApplicationDescription</A></B>()</CODE> |
| |
| <BR> |
| Gets the description of the third-party application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getApplicationLogoUri()">getApplicationLogoUri</A></B>()</CODE> |
| |
| <BR> |
| Get the URI pointing to a logo image of the client application</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getApplicationName()">getApplicationName</A></B>()</CODE> |
| |
| <BR> |
| Gets the name of the third-party application |
| this client represents</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getApplicationWebUri()">getApplicationWebUri</A></B>()</CODE> |
| |
| <BR> |
| Gets the public URI of the third-party application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getClientId()">getClientId</A></B>()</CODE> |
| |
| <BR> |
| Gets the client registration id</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getClientSecret()">getClientSecret</A></B>()</CODE> |
| |
| <BR> |
| Gets the client secret</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getRedirectUris()">getRedirectUris</A></B>()</CODE> |
| |
| <BR> |
| Gets a list of URIs the AuthorizationService |
| may return the authorization code to</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#getSubject()">getSubject</A></B>()</CODE> |
| |
| <BR> |
| Gets the <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>UserSubject</CODE></A> representing this Client |
| authentication</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#isConfidential()">isConfidential</A></B>()</CODE> |
| |
| <BR> |
| Gets the confidentiality status of this client application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setAllowedGrantTypes(java.util.List)">setAllowedGrantTypes</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> allowedGrantTypes)</CODE> |
| |
| <BR> |
| Sets the list of access token grant types this client |
| can use to obtain the access tokens.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setApplicationDescription(java.lang.String)">setApplicationDescription</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationDescription)</CODE> |
| |
| <BR> |
| Sets the description of the third-party application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setApplicationLogoUri(java.lang.String)">setApplicationLogoUri</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> logoPath)</CODE> |
| |
| <BR> |
| Sets the URI pointing to a logo image of the client application</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setApplicationName(java.lang.String)">setApplicationName</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationName)</CODE> |
| |
| <BR> |
| Sets the name of the third-party application |
| this client represents</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setApplicationWebUri(java.lang.String)">setApplicationWebUri</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationWebUri)</CODE> |
| |
| <BR> |
| Sets the public URI of the third-party application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setConfidential(boolean)">setConfidential</A></B>(boolean isConf)</CODE> |
| |
| <BR> |
| Sets the confidentiality status of this client application.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setRedirectUris(java.util.List)">setRedirectUris</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> redirectUris)</CODE> |
| |
| <BR> |
| Sets a list of URIs the AuthorizationService |
| may return the authorization code to.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/Client.html#setSubject(org.apache.cxf.rs.security.oauth2.common.UserSubject)">setSubject</A></B>(<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</A> subject)</CODE> |
| |
| <BR> |
| Sets the <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>UserSubject</CODE></A> representing this Client |
| authentication, may be setup during the registration.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="Client(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3> |
| Client</H3> |
| <PRE> |
| public <B>Client</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientId, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientSecret, |
| boolean isConfidential)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="Client(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| Client</H3> |
| <PRE> |
| public <B>Client</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientId, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clientSecret, |
| boolean isConfidential, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationName, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationWebUri)</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ 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="getClientId()"><!-- --></A><H3> |
| getClientId</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getClientId</B>()</PRE> |
| <DL> |
| <DD>Gets the client registration id |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the consumer key</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getClientSecret()"><!-- --></A><H3> |
| getClientSecret</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getClientSecret</B>()</PRE> |
| <DL> |
| <DD>Gets the client secret |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the secret</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getApplicationName()"><!-- --></A><H3> |
| getApplicationName</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getApplicationName</B>()</PRE> |
| <DL> |
| <DD>Gets the name of the third-party application |
| this client represents |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the application name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setApplicationName(java.lang.String)"><!-- --></A><H3> |
| setApplicationName</H3> |
| <PRE> |
| public void <B>setApplicationName</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationName)</PRE> |
| <DL> |
| <DD>Sets the name of the third-party application |
| this client represents |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>applicationName</CODE> - the name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getApplicationWebUri()"><!-- --></A><H3> |
| getApplicationWebUri</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getApplicationWebUri</B>()</PRE> |
| <DL> |
| <DD>Gets the public URI of the third-party application. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the application URI</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setApplicationWebUri(java.lang.String)"><!-- --></A><H3> |
| setApplicationWebUri</H3> |
| <PRE> |
| public void <B>setApplicationWebUri</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationWebUri)</PRE> |
| <DL> |
| <DD>Sets the public URI of the third-party application. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>applicationWebUri</CODE> - the application URI</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setApplicationDescription(java.lang.String)"><!-- --></A><H3> |
| setApplicationDescription</H3> |
| <PRE> |
| public void <B>setApplicationDescription</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationDescription)</PRE> |
| <DL> |
| <DD>Sets the description of the third-party application. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>applicationDescription</CODE> - the description</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getApplicationDescription()"><!-- --></A><H3> |
| getApplicationDescription</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getApplicationDescription</B>()</PRE> |
| <DL> |
| <DD>Gets the description of the third-party application. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the application description</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setApplicationLogoUri(java.lang.String)"><!-- --></A><H3> |
| setApplicationLogoUri</H3> |
| <PRE> |
| public void <B>setApplicationLogoUri</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> logoPath)</PRE> |
| <DL> |
| <DD>Sets the URI pointing to a logo image of the client application |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>logoPath</CODE> - the logo URI</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getApplicationLogoUri()"><!-- --></A><H3> |
| getApplicationLogoUri</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getApplicationLogoUri</B>()</PRE> |
| <DL> |
| <DD>Get the URI pointing to a logo image of the client application |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the logo URI</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConfidential(boolean)"><!-- --></A><H3> |
| setConfidential</H3> |
| <PRE> |
| public void <B>setConfidential</B>(boolean isConf)</PRE> |
| <DL> |
| <DD>Sets the confidentiality status of this client application. |
| This can be used to restrict which OAuth2 flows this client |
| can participate in. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>isConf</CODE> - true if the client is confidential</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isConfidential()"><!-- --></A><H3> |
| isConfidential</H3> |
| <PRE> |
| public boolean <B>isConfidential</B>()</PRE> |
| <DL> |
| <DD>Gets the confidentiality status of this client application. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the confidentiality status</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRedirectUris(java.util.List)"><!-- --></A><H3> |
| setRedirectUris</H3> |
| <PRE> |
| public void <B>setRedirectUris</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> redirectUris)</PRE> |
| <DL> |
| <DD>Sets a list of URIs the AuthorizationService |
| may return the authorization code to. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>redirectUris</CODE> - the redirect uris</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRedirectUris()"><!-- --></A><H3> |
| getRedirectUris</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>getRedirectUris</B>()</PRE> |
| <DL> |
| <DD>Gets a list of URIs the AuthorizationService |
| may return the authorization code to |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the redirect uris</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAllowedGrantTypes(java.util.List)"><!-- --></A><H3> |
| setAllowedGrantTypes</H3> |
| <PRE> |
| public void <B>setAllowedGrantTypes</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> allowedGrantTypes)</PRE> |
| <DL> |
| <DD>Sets the list of access token grant types this client |
| can use to obtain the access tokens. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>allowedGrantTypes</CODE> - the list of grant types</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAllowedGrantTypes()"><!-- --></A><H3> |
| getAllowedGrantTypes</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>getAllowedGrantTypes</B>()</PRE> |
| <DL> |
| <DD>Gets the list of access token grant types this client |
| can use to obtain the access tokens. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the list of grant types</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSubject(org.apache.cxf.rs.security.oauth2.common.UserSubject)"><!-- --></A><H3> |
| setSubject</H3> |
| <PRE> |
| public void <B>setSubject</B>(<A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</A> subject)</PRE> |
| <DL> |
| <DD>Sets the <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>UserSubject</CODE></A> representing this Client |
| authentication, may be setup during the registration. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>subject</CODE> - the user subject</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSubject()"><!-- --></A><H3> |
| getSubject</H3> |
| <PRE> |
| public <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common">UserSubject</A> <B>getSubject</B>()</PRE> |
| <DL> |
| <DD>Gets the <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/UserSubject.html" title="class in org.apache.cxf.rs.security.oauth2.common"><CODE>UserSubject</CODE></A> representing this Client |
| authentication |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the user subject</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/Client.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="../../../../../../../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> |
| Apache CXF API</EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/AccessTokenValidation.html" title="class in org.apache.cxf.rs.security.oauth2.common"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/apache/cxf/rs/security/oauth2/common/ClientAccessToken.html" title="class in org.apache.cxf.rs.security.oauth2.common"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/apache/cxf/rs/security/oauth2/common/Client.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Client.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Apache CXF |
| </BODY> |
| </HTML> |
