org.sakaiproject.oauth.service.OAuthAdminService Maven / Gradle / Ivy

Go to download

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

Api allowing an access to a Sakai instance through OAuth 1.0.

There is a newer version: 23.3

/*
 * #%L
 * OAuth API
 * %%
 * Copyright (C) 2009 - 2013 Sakai Foundation
 * %%
 * Licensed under the Educational Community 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://opensource.org/licenses/ecl2
 * 
 * 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 org.sakaiproject.oauth.service;

import org.sakaiproject.oauth.domain.Consumer;

import java.util.Collection;

/**
 * Administration service handling every sensitive tasks.
 *
 * @author Colin Hebert
 */
public interface OAuthAdminService {
    /**
     * Get a raw consumer based on its id.
     *
     * @param consumerId Id of the desired consumer
     * @return consumer if it exists,
     */
    Consumer getConsumer(String consumerId);

    /**
     * Create a new consumer available for future oAuth communications.
     *
     * @param consumer consumer to create
     */
    void createConsumer(Consumer consumer);

    /**
     * Update a consumer with new settings.
     *
     * @param consumer consumer to update
     * @return the updated consumer
     */
    Consumer updateConsumer(Consumer consumer);

    /**
     * Delete a consumer and associated accessors.
     *
     * @param consumer consumer to delete
     */
    void deleteConsumer(Consumer consumer);

    /**
     * Get a list of every available consumer.
     *
     * @return every consumer
     */
    Collection getAllConsumers();

    /**
     * Change the record mode of a consumer.
     * 
     * A consumer with the record mode enabled will have every right and will keep every right it uses.
     * When the record mode is disabled, every right used before is still available, but others aren't anymore.

     * This is useful to setup a new consumer and enable its rights without having to look for every necessary right.
     * 
     *
     * @param consumer consumer on which the record mode will be enabled or disabled.
     */
    void switchRecordMode(Consumer consumer);
}