View Javadoc
1   /*
2    * Copyright 2008 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.ws.soap.security.wss4j.callback;
18  
19  import java.io.Serializable;
20  import javax.security.auth.callback.Callback;
21  
22  import org.apache.ws.security.WSUsernameTokenPrincipal;
23  
24  /**
25   * Underlying security services instantiate and pass a <code>UsernameTokenPrincipalCallback</code> to the
26   * <code>handle</code> method of a <code>CallbackHandler</code> to pass a security
27   * <code>WSUsernameTokenPrincipal</code>.
28   *
29   * @author Arjen Poutsma
30   * @see WSUsernameTokenPrincipal
31   * @since 1.5.0
32   */
33  public class UsernameTokenPrincipalCallback implements Callback, Serializable {
34  
35      private static final long serialVersionUID = -3022202225157082715L;
36  
37      private final WSUsernameTokenPrincipal principal;
38  
39      /** Construct a <code>UsernameTokenPrincipalCallback</code>. */
40      public UsernameTokenPrincipalCallback(WSUsernameTokenPrincipal principal) {
41          this.principal = principal;
42      }
43  
44      /** Get the retrieved <code>Principal</code>. */
45      public WSUsernameTokenPrincipal getPrincipal() {
46          return principal;
47      }
48  }