org.xwiki.script.safe.AbstractSafeObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-script Show documentation

Scripting APIs, on top of JSR-223

There is a newer version: 16.10.0-rc-1

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.script.safe;

import org.xwiki.script.wrap.AbstractWrappingObject;

/**
 * Encapsulate an object in a safe way for public scripts.
 *
 * @param  the type of the wrapped object
 * @version $Id: 7a0cef24e33017a62aa3747e37c61103c8afddf9 $
 * @since 16.2.0RC1
 */
public abstract class AbstractSafeObject extends AbstractWrappingObject
{
    /**
     * The message used in forbidden access exceptions.
     */
    public static final String FORBIDDEN = "Operation forbidden in script proxy";

    /**
     * The provider of instances safe for public scripts.
     */
    protected ScriptSafeProvider