com.googlecode.fascinator.api.access.AccessControlSchema Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fascinator-plugin-api Show documentation

https://sites.google.com/site/fascinatorhome/home/documentation/technical/documents/plugin-api

The newest version!

/*
 * The Fascinator - Plugin API
 * Copyright (C) 2008-2010 University of Southern Queensland
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package com.googlecode.fascinator.api.access;

/**
 * An object for access control plugins to desribe a set of security
 * credentials as applied for an instance of security.
 *
 * Could be as simple as the role, or it could be a data relationship
 * that a plugin can map to a role without exposing the role itself
 * to admin staff or end users.
 * 
 * @author Greg Pendlebury
 */
public interface AccessControlSchema {

    /**
     * Will return a JSON string description of an extending classes'
     * fields.
     *
     * @param property The class field to retrieve
     * @return The value of the property
     */
    public String describeMetadata();

    /**
     * Retrieves a given property for this schema object.
     *
     * @param property The class field to retrieve
     * @return The value of the property
     */
    public String get(String property);

    /**
     * Sets a given property for this schema object.
     *
     * @param property The class field to set
     * @param value The value to place in the field
     */
    public void set(String property, String value);

    /**
     * Set the record id associated with a schema instance
     *
     * @param newid The id of the record
     */
    public void setRecordId(String newid);

    /**
     * Get the record id associated with a schema instance
     *
     * @return newid The id of the record
     */
    public String getRecordId();

    /**
     * Used by the access control manager to track the schema's origin
     *
     * @param plugin The id of the access control plugin
     */
    public void setSource(String plugin);

    /**
     * Used by the access control manager to track the schema's origin
     *
     * @return The id of the access control plugin
     */
    public String getSource();
}