ContextCurrentService.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI licenses this file to you under the Apache 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://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */

package org.openengsb.core.api.context;

import java.util.List;

/**
 * Service for setting the thread-local context for further query- and management-requests.
 */
public interface ContextCurrentService extends ContextService {

    /**
     * Creates a new empty context with the given {@code contextId}.
     * 
     * @throws IllegalArgumentException if a context with the given id exists
     */
    void createContext(String contextId);

    /**
     * Removes the given context
     */
    void deleteContext(String contextId);

    /**
     * Get all root context nodes in a natural order. These can be set using the {@link #setThreadLocalContext(String)}
     * method.
     */
    List<String> getAvailableContexts();

}