org.picketlink.config.federation.handler.Handlers Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source
 *
 * Copyright 2013 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed 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.picketlink.config.federation.handler;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * 
 * Java class for Handlers complex type.
 *
 * 

 * The following schema fragment specifies the expected content contained within this class.
 *
 * 
 * <complexType name="Handlers">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element name="Handler" type="{urn:picketlink:identity-federation:handler:config:1.0}Handler"
 * maxOccurs="unbounded"/>
 *       </sequence>
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * 
 */
public class Handlers {

    protected String handlerChainClass;
    private boolean locking = true;

    protected List handler = new ArrayList();

    public void add(Handler h) {
        this.handler.add(h);
    }

    public void remove(Handler h) {
        this.handler.remove(h);
    }

    /**
     * Gets the value of the handler property.
     * 
     * Objects of the following type(s) are allowed in the list {@link Handler }
     */
    public List getHandler() {
        return Collections.unmodifiableList(this.handler);
    }

    /**
     * 

     * Sets the Handler chain class.
     * 
     *
     * @param samlHandlerChainClass value must be a subclass of #{@link SAML2HandlerChain}
     */
    public void setHandlerChainClass(String samlHandlerChainClass) {
        this.handlerChainClass = samlHandlerChainClass;
    }

    /**
     * Get the Handler chain class FQN
     *
     * @return
     */
    public String getHandlerChainClass() {
        return this.handlerChainClass;
    }

    /**
     * Set the list of {@link Handler}
     *
     * @param theHandlers
     */
    public void setHandlers(List theHandlers) {
        handler.addAll(theHandlers);
    }

    /**
     * Sets the locking behavior of the handler chain
     *
     * @return
     */
    public void setLocking(final Boolean locking) {
        this.locking = locking;
    }

    /**
     * Indicates if the handler chain execution should be locked
     *
     * @return
     */
    public boolean isLocking() {
        return locking;
    }
}