org.seasar.framework.util.DefaultMemberAccess Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nos2jdbc-util Show documentation
The newest version!
package org.seasar.framework.util;

import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Member;
import java.lang.reflect.Modifier;
import java.util.Map;

import ognl.AccessibleObjectHandler;
import ognl.MemberAccess;
import ognl.OgnlContext;
import ognl.OgnlRuntime;

/**
 * This class provides methods for setting up and restoring
 * access in a Field.  Java 2 provides access utilities for setting
 * and getting fields that are non-public.  This object provides
 * coarse-grained access controls to allow access to private, protected
 * and package protected members.  This will apply to all classes
 * and members.
 *
 * @author Luke Blanshard ([email protected])
 * @author Drew Davidson ([email protected])
 * @version 15 October 1999
 */
public class DefaultMemberAccess implements MemberAccess
{
    /*
     * Assign an accessibility modification mechanism, based on Major Java Version.
     *   Note: Can be override using a Java option flag {@link OgnlRuntime#USE_PREJDK9_ACESS_HANDLER}.
     */
    private static final AccessibleObjectHandler _accessibleObjectHandler;
    static {
        _accessibleObjectHandler = OgnlRuntime.usingJDK9PlusAccessHandler() ? AccessibleObjectHandlerJDK9Plus.createHandler() :
            AccessibleObjectHandlerPreJDK9.createHandler();
    }
    public boolean      allowPrivateAccess = false;
    public boolean      allowProtectedAccess = false;
    public boolean      allowPackageProtectedAccess = false;

        /*===================================================================
                Constructors
          ===================================================================*/
        public DefaultMemberAccess(boolean allowAllAccess)
        {
            this(allowAllAccess, allowAllAccess, allowAllAccess);
        }

        public DefaultMemberAccess(boolean allowPrivateAccess, boolean allowProtectedAccess, boolean allowPackageProtectedAccess)
        {
            super();
            this.allowPrivateAccess = allowPrivateAccess;
            this.allowProtectedAccess = allowProtectedAccess;
            this.allowPackageProtectedAccess = allowPackageProtectedAccess;
        }

        /*===================================================================
                Public methods
          ===================================================================*/
        public boolean getAllowPrivateAccess()
        {
            return allowPrivateAccess;
        }

        public void setAllowPrivateAccess(boolean value)
        {
            allowPrivateAccess = value;
        }

        public boolean getAllowProtectedAccess()
        {
            return allowProtectedAccess;
        }

        public void setAllowProtectedAccess(boolean value)
        {
            allowProtectedAccess = value;
        }

        public boolean getAllowPackageProtectedAccess()
        {
            return allowPackageProtectedAccess;
        }

        public void setAllowPackageProtectedAccess(boolean value)
        {
            allowPackageProtectedAccess = value;
        }

        /*===================================================================
                MemberAccess interface
          ===================================================================*/
    @Override
    public Object setup(OgnlContext context, Object target, Member member, String propertyName)
    {
        Object      result = null;

        if (isAccessible(context, target, member, propertyName)) {
            AccessibleObject    accessible = (AccessibleObject) member;

            //if (!accessible.isAccessible()) {
            if (!accessible.canAccess(target)) {
                result = Boolean.FALSE;
                _accessibleObjectHandler.setAccessible(accessible, true);
            }
        }
        return result;
    }

    @Override
    public void restore(OgnlContext context, Object target, Member member, String propertyName, Object state)
    {
        if (state != null) {
            final AccessibleObject  accessible = (AccessibleObject) member;
            final boolean           stateboolean = ((Boolean) state).booleanValue();  // Using twice (avoid unboxing)
            if (!stateboolean) {
                _accessibleObjectHandler.setAccessible(accessible, stateboolean);
            } else {
                throw new IllegalArgumentException("Improper restore state [" + stateboolean + "] for target [" + target +
                                                   "], member [" + member + "], propertyName [" + propertyName + "]");
            }
        }
    }

    /**
        Returns true if the given member is accessible or can be made accessible
        by this object.
     *
     * @param context the current execution context (not used).
     * @param target the Object to test accessibility for (not used).
     * @param member the Member to test accessibility for.
     * @param propertyName the property to test accessibility for (not used).
     * @return true if the member is accessible in the context, false otherwise.
     */
        @Override
        public boolean isAccessible(OgnlContext context, Object target, Member member, String propertyName)
        {
            int         modifiers = member.getModifiers();
            boolean     result = Modifier.isPublic(modifiers);

            if (!result) {
                if (Modifier.isPrivate(modifiers)) {
                    result = getAllowPrivateAccess();
                } else {
                    if (Modifier.isProtected(modifiers)) {
                        result = getAllowProtectedAccess();
                    } else {
                        result = getAllowPackageProtectedAccess();
                    }
                }
            }
            return result;
        }
}