org.jenkinsci.plugins.plaincredentials

Interface FileCredentials

All Superinterfaces:

com.cloudbees.plugins.credentials.Credentials, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, hudson.ExtensionPoint, com.cloudbees.plugins.credentials.common.IdCredentials, Serializable, com.cloudbees.plugins.credentials.common.StandardCredentials

All Known Implementing Classes:

FileCredentialsImpl

@NameWith(value=FileCredentials.NameProvider.class)
public interface FileCredentials
extends com.cloudbees.plugins.credentials.common.StandardCredentials

Credentials consisting of a secret file.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileCredentials.NameProvider

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method and Description
InputStream	getContent() Obtains the actual content of the secret file as a bytestream.
String	getFileName() Indicates the intended naming of the secret content.

Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

getDescription

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getDescriptor, getScope

Method Detail

getFileName

@Nonnull
String getFileName()

Indicates the intended naming of the secret content. For example, private-keys.zip or keystore.

Returns:

a simple file name (no path separators)

getContent

@Nonnull
InputStream getContent()
                         throws IOException

Obtains the actual content of the secret file as a bytestream.

Returns:

some binary data

Throws:

IOException - if the data cannot be loaded