View Javadoc

1   /*
2    * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
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 edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition;
18  
19  import org.opensaml.xml.util.DatatypeHelper;
20  
21  import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
22  import edu.internet2.middleware.shibboleth.common.attribute.provider.BasicAttribute;
23  import edu.internet2.middleware.shibboleth.common.attribute.resolver.AttributeResolutionException;
24  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ShibbolethResolutionContext;
25  
26  /**
27   * Attribute definition that exposes the principals authentication method as an attribute.
28   */
29  public class PrincipalAuthenticationMethodDefinition extends BaseAttributeDefinition {
30  
31      /** {@inheritDoc} */
32      protected BaseAttribute<String> doResolve(ShibbolethResolutionContext resolutionContext) {
33          BasicAttribute<String> attribute = new BasicAttribute<String>();
34          attribute.setId(getId());
35  
36          String authnMethod = resolutionContext.getAttributeRequestContext().getPrincipalAuthenticationMethod();
37          if (!DatatypeHelper.isEmpty(authnMethod)) {
38              attribute.getValues().add(authnMethod);
39          }
40  
41          return attribute;
42      }
43  
44      /** {@inheritDoc} */
45      public void validate() throws AttributeResolutionException {
46          // do nothing
47      }
48  }