AiravataSecurityManager.java

/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.apache.airavata.api.server.security;

import org.apache.airavata.model.security.AuthzToken;
import org.apache.airavata.security.AiravataSecurityException;

import java.util.Map;

public interface AiravataSecurityManager {
    /**
     * Implement this method in your SecurityManager to perform necessary initializations at the server startup.
     * @throws AiravataSecurityException
     */
    public void initializeSecurityInfra() throws AiravataSecurityException;

    /**
     * Implement this method with the user authentication/authorization logic in your SecurityManager.
     * @param authzToken : this includes OAuth token and user's claims
     * @param metaData : this includes other meta data needed for security enforcements.
     * @return
     * @throws AiravataSecurityException
     */
    public boolean isUserAuthorized(AuthzToken authzToken, Map<String, String> metaData) throws AiravataSecurityException;
}