NativeAttribute.java

/*
 * ====================
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License("CDDL") (the "License").  You may not use this file
 * except in compliance with the License.
 *
 * You can obtain a copy of the License at
 * http://opensource.org/licenses/cddl1.php
 * See the License for the specific language governing permissions and limitations
 * under the License.
 *
 * When distributing the Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://opensource.org/licenses/cddl1.php.
 * If applicable, add the following below this CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * ====================
 */

package org.identityconnectors.solaris.attr;

import java.util.HashMap;
import java.util.Map;

public enum NativeAttribute {
    /** USER/GROUP attribute. */
    NAME,
    /** USER/GROUP attribute. */
    ID,
    /** USER attribute: primary group. */
    GROUP_PRIM,
    /** USER attribute. */
    COMMENT,
    /** USER attribute: secondary groups. */
    GROUPS_SEC() {
        @Override
        public boolean isSingleValue() {
            return false;
        }
    },
    /** USER attribute. */
    DIR,
    /** USER attribute. */
    SHELL,
    /**
     * USER attribute. Other nick for {@link NativeAttribute#PWSTAT} in the
     * adapter for this attribute was PASSWORD_FORCE_CHANGE.
     *
     * Solaris resource allows only update of this attribute to true. E.g. we
     * can turn on enforcing of changing user's password upon next login. But
     * there is no way to turn this off.
     *
     * The only way to deactivate force_change is to have the user log in, and
     * change her password.
     */
    PWSTAT,
    /** USER attribute. */
    MIN_DAYS_BETWEEN_CHNG,
    /** USER attribute. */
    MAX_DAYS_BETWEEN_CHNG,
    /** USER attribute. */
    DAYS_BEFORE_TO_WARN,
    /** USER attribute. */
    USER_EXPIRE,
    /** USER attribute. */
    USER_INACTIVE,
    /** USER attribute. */
    LOCK,
    
    LAST_PASSWORD_CHANGE,
    
    REGISTRY,

    SYSTEM,
    
    /** USER attribute. */
    ROLES {
        @Override
        public boolean isSingleValue() {
            return false;
        }
    },
    /** USER attribute. */
    AUTHS {
        @Override
        public boolean isSingleValue() {
            return false;
        }
    },
    /** USER attribute. */
    PROFILES {
        @Override
        public boolean isSingleValue() {
            return false;
        }
    },
    /** USER attribute: time when the user was last logged in. */
    LAST_LOGIN,

    /** GROUP attribute. */
    USERS {
        @Override
        public boolean isSingleValue() {
            return false;
        }
    };

    private static final Map<String, NativeAttribute> STRING_TO_NATIVE =
            new HashMap<String, NativeAttribute>();
    static {
        for (NativeAttribute accAttr : values()) {
            STRING_TO_NATIVE.put(accAttr.getName(), accAttr);
        }
    }

    /**
     * is able to transform string value into NativeAttribute, given, that we
     * respect the name defined by {@see NativeAttribute#getName()}.
     */
    public static NativeAttribute forAttributeName(String nativeAttr) {
        return STRING_TO_NATIVE.get(nativeAttr);
    }

    /** @return String representation of the native attribute name. */
    public String getName() {
        return this.toString();
    }

    /** @return true if the attribute is singleValue, false if it is multivalue */
    public boolean isSingleValue() {
        return true;
    }
}