Interface FileCredentials
- All Superinterfaces:
com.cloudbees.plugins.credentials.Credentials
,Describable<com.cloudbees.plugins.credentials.Credentials>
,ExtensionPoint
,com.cloudbees.plugins.credentials.common.IdCredentials
,Serializable
,com.cloudbees.plugins.credentials.common.StandardCredentials
- All Known Implementing Classes:
FileCredentialsImpl
@NameWith(NameProvider.class)
public interface FileCredentials
extends com.cloudbees.plugins.credentials.common.StandardCredentials
Credentials consisting of a secret file.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials
com.cloudbees.plugins.credentials.common.IdCredentials.Helpers
-
Method Summary
Modifier and TypeMethodDescriptionObtains the actual content of the secret file as a bytestream.Indicates the intended naming of the secret content.Methods inherited from interface com.cloudbees.plugins.credentials.Credentials
forRun, getDescriptor, getScope
Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials
getId
Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials
getDescription
-
Method Details
-
getFileName
Indicates the intended naming of the secret content. For example,private-keys.zip
orkeystore
.- Returns:
- a simple file name (no path separators)
-
getContent
Obtains the actual content of the secret file as a bytestream.- Returns:
- some binary data
- Throws:
IOException
- if the data cannot be loaded
-