ProGradePrincipal.java

/*
 * #%L
 * pro-grade
 * %%
 * Copyright (C) 2013 - 2014 Ondřej Lukáš, Josef Cacek
 * %%
 * 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.
 * #L%
 */
package net.sourceforge.prograde.policy;

/**
 * Class representing parsed principal which is used in ProgradePolicyEntry.
 * 
 * @author Ondrej Lukas
 */
public class ProGradePrincipal {

    private String className;
    private String principalName;
    private boolean wildcardClassName;
    private boolean wildcardPrincipal;

    /**
     * Nonparametric constructor of ProgradePrincipal.
     */
    public ProGradePrincipal() {
    }

    /**
     * Constructor of ProgradePrincipal.
     * 
     * @param className name of Principal class
     * @param principalName name of Principal
     * @param wildcardClassName true if principal entry has wildcard for principal class name or false if it doesn't have it
     * @param wildcardPrincipal true if principal entry has wildcard for principal name or false if it doesn't have it
     */
    public ProGradePrincipal(String className, String principalName, boolean wildcardClassName, boolean wildcardPrincipal) {
        this.className = className;
        this.principalName = principalName;
        this.wildcardClassName = wildcardClassName;
        this.wildcardPrincipal = wildcardPrincipal;
    }

    /**
     * Getter of Principal class name.
     * 
     * @return name of Principal class
     */
    public String getClassName() {
        return className;
    }

    /**
     * Getter of Principal name.
     * 
     * @return name of Principal
     */
    public String getPrincipalName() {
        return principalName;
    }

    /**
     * Method for determining whether principal has wildcard for class name.
     * 
     * @return true if principal has wildcard for class name or false if it doesn't have it
     */
    public boolean hasWildcardClassName() {
        return wildcardClassName;
    }

    /**
     * Method for determining whether principal has wildcard for principal name.
     * 
     * @return true if principal has wildcard for principal name or false if it doesn't have it
     */
    public boolean hasWildcardPrincipal() {
        return wildcardPrincipal;
    }

    /**
     * Setter of Principal class name.
     * 
     * @param type name of Principal class
     */
    public void setClassName(String type) {
        this.className = type;
    }

    /**
     * Setter of Principal name.
     * 
     * @param principalName name of Principal
     */
    public void setPrincipalName(String principalName) {
        this.principalName = principalName;
    }

    /**
     * Setter of principal class name wildcard.
     * 
     * @param wildcardType true if principal has wildcard for class name or false if it doesn't have it
     */
    public void setWildcardClassName(boolean wildcardType) {
        this.wildcardClassName = wildcardType;
    }

    /**
     * Setter of principal name wildcard.
     * 
     * @param wildcardPrincipal true if principal has wildcard for principal name or false if it doesn't have it
     */
    public void setWildcardPrincipal(boolean wildcardPrincipal) {
        this.wildcardPrincipal = wildcardPrincipal;
    }

    @Override
    public String toString() {
        String toReturn = "";
        String toReturnClass = (wildcardClassName) ? "*" : className;
        String toReturnName = (wildcardPrincipal) ? "*" : principalName;
        toReturn += toReturnClass + "/" + toReturnName;
        return toReturn;
    }
}