svn commit: r1560949 - /cxf/trunk/rt/ws/security/src/main/java/org/apache/cxf/ws/security/SecurityConstants.java

[co...@apache.org]

Author: coheigea
Date: Fri Jan 24 11:49:44 2014
New Revision: 1560949

URL: http://svn.apache.org/r1560949
Log:
[CXF-5518][CXF-5519][CXF-5520][CXF-5521] - Delegation handling documentation improvements

Modified:
    cxf/trunk/rt/ws/security/src/main/java/org/apache/cxf/ws/security/SecurityConstants.java

Modified: cxf/trunk/rt/ws/security/src/main/java/org/apache/cxf/ws/security/SecurityConstants.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/ws/security/src/main/java/org/apache/cxf/ws/security/SecurityConstants.java?rev=1560949&r1=1560948&r2=1560949&view=diff
==============================================================================
--- cxf/trunk/rt/ws/security/src/main/java/org/apache/cxf/ws/security/SecurityConstants.java (original)
+++ cxf/trunk/rt/ws/security/src/main/java/org/apache/cxf/ws/security/SecurityConstants.java Fri Jan 24 11:49:44 2014
@@ -467,17 +467,35 @@ public final class SecurityConstants {
     
     /**
      * The token to be sent to the STS in an "ActAs" field. It can be either:
-     * a) A String
+     * a) A String (which must be an XML statement like "<wst:OnBehalfOf xmlns:wst=...>...</wst:OnBehalfOf>")
      * b) A DOM Element
      * c) A CallbackHandler object to use to obtain the token
+     * 
+     * In the case of a CallbackHandler, it must be able to handle a 
+     * org.apache.cxf.ws.security.trust.delegation.DelegationCallback Object, which contains a 
+     * reference to the current Message. The CallbackHandler implementation is required to set 
+     * the token Element to be sent in the request on the Callback.
+     * 
+     * Some examples that can be reused are:
+     * org.apache.cxf.ws.security.trust.delegation.ReceivedTokenCallbackHandler
+     * org.apache.cxf.ws.security.trust.delegation.WSSUsernameCallbackHandler
      */
     public static final String STS_TOKEN_ACT_AS = "ws-security.sts.token.act-as";
     
     /**
      * The token to be sent to the STS in an "OnBehalfOf" field. It can be either:
-     * a) A String
+     * a) A String (which must be an XML statement like "<wst:OnBehalfOf xmlns:wst=...>...</wst:OnBehalfOf>")
      * b) A DOM Element
      * c) A CallbackHandler object to use to obtain the token
+     * 
+     * In the case of a CallbackHandler, it must be able to handle a 
+     * org.apache.cxf.ws.security.trust.delegation.DelegationCallback Object, which contains a 
+     * reference to the current Message. The CallbackHandler implementation is required to set 
+     * the token Element to be sent in the request on the Callback.
+     * 
+     * Some examples that can be reused are:
+     * org.apache.cxf.ws.security.trust.delegation.ReceivedTokenCallbackHandler
+     * org.apache.cxf.ws.security.trust.delegation.WSSUsernameCallbackHandler
      */
     public static final String STS_TOKEN_ON_BEHALF_OF = "ws-security.sts.token.on-behalf-of";