View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition;
19  
20  import org.opensaml.xml.util.DatatypeHelper;
21  
22  import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
23  import edu.internet2.middleware.shibboleth.common.attribute.provider.BasicAttribute;
24  import edu.internet2.middleware.shibboleth.common.attribute.resolver.AttributeResolutionException;
25  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ShibbolethResolutionContext;
26  
27  /**
28   * Attribute definition that exposes the principals authentication method as an attribute.
29   */
30  public class PrincipalAuthenticationMethodDefinition extends BaseAttributeDefinition {
31  
32      /** {@inheritDoc} */
33      protected BaseAttribute<String> doResolve(ShibbolethResolutionContext resolutionContext) {
34          BasicAttribute<String> attribute = new BasicAttribute<String>();
35          attribute.setId(getId());
36  
37          String authnMethod = resolutionContext.getAttributeRequestContext().getPrincipalAuthenticationMethod();
38          if (!DatatypeHelper.isEmpty(authnMethod)) {
39              attribute.getValues().add(authnMethod);
40          }
41  
42          return attribute;
43      }
44  
45      /** {@inheritDoc} */
46      public void validate() throws AttributeResolutionException {
47          // do nothing
48      }
49  }