org.jenkinsci.plugins.plaincredentials.impl

Class FileCredentialsImpl

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

org.jenkinsci.plugins.plaincredentials.impl.FileCredentialsImpl

All Implemented Interfaces:

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

public final class FileCredentialsImpl
extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
implements FileCredentials

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileCredentialsImpl.DescriptorImpl

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

Nested classes/interfaces inherited from interface org.jenkinsci.plugins.plaincredentials.FileCredentials

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

Constructor Summary

Constructors

Constructor and Description
FileCredentialsImpl(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, org.apache.commons.fileupload.FileItem file, String fileName, String data)

Method Summary

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

Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

equals, getDescription, getId, hashCode

Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials

getDescriptor, getScope

Methods inherited from class java.lang.Object

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

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

Constructor Detail

FileCredentialsImpl

@DataBoundConstructor
public FileCredentialsImpl(@CheckForNull
                                                 com.cloudbees.plugins.credentials.CredentialsScope scope,
                                                 @CheckForNull
                                                 String id,
                                                 @CheckForNull
                                                 String description,
                                                 @Nonnull
                                                 org.apache.commons.fileupload.FileItem file,
                                                 @CheckForNull
                                                 String fileName,
                                                 @CheckForNull
                                                 String data)
                                          throws IOException

Throws:

IOException

Method Detail

getFileName

public String getFileName()

Description copied from interface: FileCredentials

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

Specified by:

getFileName in interface FileCredentials

Returns:

a simple file name (no path separators)

getData

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public String getData()

getContent

public InputStream getContent()
                       throws IOException

Description copied from interface: FileCredentials

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

Specified by:

getContent in interface FileCredentials

Returns:

some binary data

Throws:

IOException - if the data cannot be loaded