org.apache.flink.runtime.security.modules.SecurityModuleFactory Maven / Gradle / Ivy
/*
* 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.flink.runtime.security.modules;
import org.apache.flink.runtime.security.SecurityConfiguration;
/**
* A factory for a {@link SecurityModule}. A factory can determine whether a {@link SecurityModule}
* works in the given environment (for example, it can check whether Hadoop dependencies are
* available) and can then create (or not) a module based on that.
*/
@FunctionalInterface
public interface SecurityModuleFactory {
/**
* Creates and returns a {@link SecurityModule}. This can return {@code null} if the type
* of {@link SecurityModule} that this factory can create does not work in the current
* environment.
*/
SecurityModule createModule(SecurityConfiguration securityConfig);
}