org.opensaml.saml.metadata.criteria.role.impl.EvaluableProtocolRoleDescriptorCriterion Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of opensaml-saml-impl Show documentation
SAML Provider Implementations
The newest version!
/*
 * Licensed to the University Corporation for Advanced Internet Development,
 * Inc. (UCAID) under one or more contributor license agreements.  See the
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You under the Apache
 * License, Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.opensaml.saml.metadata.criteria.role.impl;

import java.util.Objects;

import javax.annotation.Nonnull;

import org.opensaml.saml.criterion.ProtocolCriterion;
import org.opensaml.saml.metadata.criteria.role.EvaluableRoleDescriptorCriterion;
import org.opensaml.saml.saml2.metadata.RoleDescriptor;

import com.google.common.base.MoreObjects;

import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;

/**
 * Implementation of {@link EvaluableRoleDescriptorCriterion} which evaluates that a role descriptor
 * supports a certain protocol.
 */
public class EvaluableProtocolRoleDescriptorCriterion implements EvaluableRoleDescriptorCriterion {
    
    /** The SAML URI protocol being evaluated. */
    @Nonnull @NotEmpty private String protocol;
    
    /**
     * Constructor.
     *
     * @param criterion the protocol criterion
     */
    public EvaluableProtocolRoleDescriptorCriterion(@Nonnull final ProtocolCriterion criterion) {
        Constraint.isNotNull(criterion, "ProtocolCriterion was null");
        protocol = Constraint.isNotNull(criterion.getProtocol(), "Criterion protocol was null");
    }
    
    /**
     * Constructor.
     *
     * @param roleProtocol the protocol
     */
    public EvaluableProtocolRoleDescriptorCriterion(@Nonnull final String roleProtocol) {
        protocol = Constraint.isNotNull(StringSupport.trimOrNull(roleProtocol), 
                "Entity Role protocol was null or empty");
    }
    
    /** {@inheritDoc} */
    public boolean test(final RoleDescriptor input) {
        if (input == null) {
            return false;
        }
        
        return input.isSupportedProtocol(protocol);
    }
    
    /** {@inheritDoc} */
    public int hashCode() {
        return protocol.hashCode();
    }

    /** {@inheritDoc} */
    public boolean equals(final Object other) {
        if (this == other) {
            return true;
        }
        
        if (other instanceof EvaluableProtocolRoleDescriptorCriterion) {
            return Objects.equals(this.protocol, ((EvaluableProtocolRoleDescriptorCriterion)other).protocol);
        }
        
        return false;
    }

    /** {@inheritDoc} */
    public String toString() {
        return MoreObjects.toStringHelper(this)
                .add("protocol", protocol)
                .toString();
    }
    
}