trunk/src/java/org/apache/lenya/ac/Credential.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF 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.apache.lenya.ac;

/**
 * A credential assigns a {@link Role} to an {@link Accreditable}.
 */
public interface Credential {

    /**
     * @return The accreditable this credential applies to.
     */
    Accreditable getAccreditable();

    /**
     * @return The role of this credential.
     */
    Role getRole();

    /**
     * @return The method, one of {@link #GRANT} and {@link #DENY}.
     */
    String getMethod();
    
    /**
     * The "grant" method.
     */
    String GRANT = "grant";
    
    /**
     * The "deny" method.
     */
    String DENY = "deny";
}