001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *      http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.oozie.action.hadoop;
020
021import org.apache.hadoop.mapred.JobConf;
022import org.apache.oozie.action.ActionExecutor.Context;
023
024@SuppressWarnings("deprecation")
025public abstract class Credentials {
026
027    /**
028     * This is the interface for all the Credentials implementation. Any new credential implementaion must implement
029     * this function. This function should modify the jobconf which will be used further to pass the credentials to the
030     * tasks while running it. Credentials properties and context is also provided by that user can get all the
031     * necessary configuration.
032     *
033     * @param jobconf job conf where the token will insert into
034     * @param props properties for getting credential token or certificate
035     * @param context workflow context
036     * @throws Exception thrown if failed
037     */
038    public abstract void addtoJobConf(JobConf jobconf, CredentialsProperties props, Context context) throws Exception;
039}