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 */
018package org.apache.oozie.action.hadoop;
019
020import org.apache.hadoop.mapred.JobConf;
021import org.apache.oozie.action.ActionExecutor.Context;
022
023@SuppressWarnings("deprecation")
024public abstract class Credentials {
025
026    /**
027     * This is the interface for all the Credentials implementation. Any new credential implementaion must implement
028     * this function. This function should modify the jobconf which will be used further to pass the credentials to the
029     * tasks while running it. Credentials properties and context is also provided by that user can get all the
030     * necessary configuration.
031     *
032     * @param jobconf job conf where the token will insert into
033     * @param props properties for getting credential token or certificate
034     * @param context workflow context
035     * @throws Exception thrown if failed
036     */
037    public abstract void addtoJobConf(JobConf jobconf, CredentialsProperties props, Context context) throws Exception;
038}