Package org.apache.hadoop.security.token

Class DtFileOperations

java.lang.Object

org.apache.hadoop.security.token.DtFileOperations

public final class DtFileOperations
extends java.lang.Object

DtFileOperations is a collection of delegation token file operations.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FORMAT_JAVA	Use FORMAT_* as arguments to format parameters.
static java.lang.String	FORMAT_PB	Use FORMAT_* as arguments to format parameters.

Method Summary

Modifier and Type	Method	Description
static void	aliasTokenFile(java.io.File tokenFile, java.lang.String fileFormat, Text alias, Text service, Configuration conf)	Alias a token from a file and save back to file in the local filesystem.
static void	appendTokenFiles(java.util.ArrayList<java.io.File> tokenFiles, java.lang.String fileFormat, Configuration conf)	Append tokens from list of files in local filesystem, saving to last file.
static void	doFormattedWrite(java.io.File f, java.lang.String format, Credentials creds, Configuration conf)	Write out a Credentials object as a local file.
static void	getTokenFile(java.io.File tokenFile, java.lang.String fileFormat, Text alias, Text service, java.lang.String url, java.lang.String renewer, Configuration conf)	Fetch a token from a service and save to file in the local filesystem.
static void	importTokenFile(java.io.File tokenFile, java.lang.String fileFormat, Text alias, java.lang.String base64, Configuration conf)	Import a token from a base64 encoding into the local filesystem.
static void	printCredentials(Credentials creds, Text alias, java.io.PrintStream out)	Print out a Credentials object.
static void	printTokenFile(java.io.File tokenFile, Text alias, Configuration conf, java.io.PrintStream out)	Print out a Credentials file from the local filesystem.
static void	removeTokenFromFile(boolean cancel, java.io.File tokenFile, java.lang.String fileFormat, Text alias, Configuration conf)	Remove a token from a file in the local filesystem, matching alias.
static void	renewTokenFile(java.io.File tokenFile, java.lang.String fileFormat, Text alias, Configuration conf)	Renew a token from a file in the local filesystem, matching alias.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT_PB

public static final java.lang.String FORMAT_PB

Use FORMAT_* as arguments to format parameters. FORMAT_PB is for protobuf output.

See Also:

Constant Field Values

FORMAT_JAVA

public static final java.lang.String FORMAT_JAVA

Use FORMAT_* as arguments to format parameters. FORMAT_JAVA is a legacy option for java serialization output.

See Also:

Constant Field Values

Method Detail

doFormattedWrite

public static void doFormattedWrite(java.io.File f,
                                    java.lang.String format,
                                    Credentials creds,
                                    Configuration conf)
                             throws java.io.IOException

Write out a Credentials object as a local file.

Parameters:

f - a local File object.

format - a string equal to FORMAT_PB or FORMAT_JAVA.

creds - the Credentials object to be written out.

conf - a Configuration object passed along.

Throws:

java.io.IOException - raised on errors performing I/O.

printTokenFile

public static void printTokenFile(java.io.File tokenFile,
                                  Text alias,
                                  Configuration conf,
                                  java.io.PrintStream out)
                           throws java.io.IOException

Print out a Credentials file from the local filesystem.

Parameters:

tokenFile - a local File object.

alias - print only tokens matching alias (null matches all).

conf - Configuration object passed along.

out - print to this stream.

Throws:

java.io.IOException - raised on errors performing I/O.

printCredentials

public static void printCredentials(Credentials creds,
                                    Text alias,
                                    java.io.PrintStream out)
                             throws java.io.IOException

Print out a Credentials object.

Parameters:

creds - the Credentials object to be printed out.

alias - print only tokens matching alias (null matches all).

out - print to this stream.

Throws:

java.io.IOException - failure to unmarshall a token identifier.

getTokenFile

public static void getTokenFile(java.io.File tokenFile,
                                java.lang.String fileFormat,
                                Text alias,
                                Text service,
                                java.lang.String url,
                                java.lang.String renewer,
                                Configuration conf)
                         throws java.lang.Exception

Fetch a token from a service and save to file in the local filesystem.

Parameters:

tokenFile - a local File object to hold the output.

fileFormat - a string equal to FORMAT_PB or FORMAT_JAVA, for output

alias - overwrite service field of fetched token with this text.

service - use a DtFetcher implementation matching this service text.

url - pass this URL to fetcher after stripping any http/s prefix.

renewer - pass this renewer to the fetcher.

conf - Configuration object passed along.

Throws:

java.io.IOException - raised on errors performing I/O.

java.lang.Exception

aliasTokenFile

public static void aliasTokenFile(java.io.File tokenFile,
                                  java.lang.String fileFormat,
                                  Text alias,
                                  Text service,
                                  Configuration conf)
                           throws java.lang.Exception

Alias a token from a file and save back to file in the local filesystem.

Parameters:

tokenFile - a local File object to hold the input and output.

fileFormat - a string equal to FORMAT_PB or FORMAT_JAVA, for output

alias - overwrite service field of fetched token with this text.

service - only apply alias to tokens matching this service text.

conf - Configuration object passed along.

Throws:

java.io.IOException - raised on errors performing I/O.

java.lang.Exception

appendTokenFiles

public static void appendTokenFiles(java.util.ArrayList<java.io.File> tokenFiles,
                                    java.lang.String fileFormat,
                                    Configuration conf)
                             throws java.io.IOException

Append tokens from list of files in local filesystem, saving to last file.

Parameters:

tokenFiles - list of local File objects. Last file holds the output.

fileFormat - a string equal to FORMAT_PB or FORMAT_JAVA, for output

conf - Configuration object passed along.

Throws:

java.io.IOException - raised on errors performing I/O.

removeTokenFromFile

public static void removeTokenFromFile(boolean cancel,
                                       java.io.File tokenFile,
                                       java.lang.String fileFormat,
                                       Text alias,
                                       Configuration conf)
                                throws java.io.IOException,
                                       java.lang.InterruptedException

Remove a token from a file in the local filesystem, matching alias.

Parameters:

cancel - cancel token as well as remove from file.

tokenFile - a local File object.

fileFormat - a string equal to FORMAT_PB or FORMAT_JAVA, for output

alias - remove only tokens matching alias; null matches all.

conf - Configuration object passed along.

Throws:

java.io.IOException - raised on errors performing I/O.

java.lang.InterruptedException - if the thread is interrupted.

renewTokenFile

public static void renewTokenFile(java.io.File tokenFile,
                                  java.lang.String fileFormat,
                                  Text alias,
                                  Configuration conf)
                           throws java.io.IOException,
                                  java.lang.InterruptedException

Renew a token from a file in the local filesystem, matching alias.

Parameters:

tokenFile - a local File object.

fileFormat - a string equal to FORMAT_PB or FORMAT_JAVA, for output

alias - renew only tokens matching alias; null matches all.

conf - Configuration object passed along.

Throws:

java.io.IOException - raised on errors performing I/O.

java.lang.InterruptedException - if the thread is interrupted.

importTokenFile

public static void importTokenFile(java.io.File tokenFile,
                                   java.lang.String fileFormat,
                                   Text alias,
                                   java.lang.String base64,
                                   Configuration conf)
                            throws java.io.IOException

Import a token from a base64 encoding into the local filesystem.

Parameters:

tokenFile - A local File object.

fileFormat - A string equal to FORMAT_PB or FORMAT_JAVA, for output.

alias - overwrite Service field of fetched token with this text.

base64 - urlString Encoding of the token to import.

conf - Configuration object passed along.

Throws:

java.io.IOException - Error to import the token into the file.