Package hudson.util

Other miscellaneous utility code

Interface Summary

Interface	Description
ConsistentHash.Hash<T>	Hashes an object to some value.
DescribableList.Owner	Deprecated. since 2008-08-15.
Function1<R,P1>	Unary function y=f(x).
InvocationInterceptor	Interceptor around InvocationHandler.
Iterators.CountingPredicate<T>
ProcessTree.ProcessCallable<T>	Code that gets executed on the machine where the ProcessTree.OSProcess is local.
ProcessTreeRemoting.IOSProcess
ProcessTreeRemoting.IProcessTree
TagCloud.WeightFunction<T>
VariableResolver<V>	Resolves variables to its value, while encapsulating how that resolution happens.

Class Summary

Class	Description
AbstractTaskListener	Deprecated. implement TaskListener directly
AdaptedIterator<T,U>	Iterator that adapts the values returned from another iterator.
AdministrativeError	Deprecated. Implement AdministrativeMonitor directly instead.
AlternativeUiTextProvider	Provides the alternative text to be rendered in the UI.
AlternativeUiTextProvider.Message<T>	Each instance of this class represents a text that can be replaced by AlternativeUiTextProvider.
Area	Represents a two dimensional area.
ArgumentListBuilder	Used to build up arguments for a process invocation.
AtomicFileWriter	Buffered FileWriter that supports atomic operations.
ByteArrayOutputStream2	ByteArrayOutputStream with access to its raw buffer.
CaseInsensitiveComparator	Deprecated. use String.CASE_INSENSITIVE_ORDER directly
CharacterEncodingFilter	Filter that sets the character encoding to be used in parsing the request to avoid Non-ASCII characters garbled.
ChartUtil	Chart generation utility code around JFreeChart.
ChartUtil.NumberOnlyBuildLabel	Can be used as a graph label.
ChunkedInputStream	Transparently coalesces chunks of a HTTP stream that uses Transfer-Encoding chunked.
ChunkedOutputStream	Implements HTTP chunking support.
ClassLoaderSanityThreadFactory	Explicitly sets the Thread.setContextClassLoader(java.lang.ClassLoader) for threads it creates to its own classloader.
ClasspathBuilder	Used to build up an argument in the classpath format.
ClockDifference	Represents a clock difference.
ColorPalette	Color constants consistent with the Hudson color palette.
ComboBoxModel	Model object for dynamically filed combo box, which is really just ArrayList<String>
CompoundEnumeration<T>	Enumeration that aggregates multiple Enumerations.
CompressedFile	Represents write-once read-many file that can be optionally compressed to save disk space.
ConsistentHash<T>	Consistent hash.
CopyOnWriteList<E>	List-like implementation that has copy-on-write semantics.
CopyOnWriteList.ConverterImpl	Converter implementation for XStream.
CopyOnWriteMap<K,V>	Map that has copy-on-write semantics.
CopyOnWriteMap.Hash<K,V>	CopyOnWriteMap backed by HashMap.
CopyOnWriteMap.Hash.ConverterImpl
CopyOnWriteMap.Tree<K,V>	CopyOnWriteMap backed by TreeMap.
CopyOnWriteMap.Tree.ConverterImpl
CyclicGraphDetector<N>	Traverses a directed graph and if it contains any cycle, throw an exception.
DaemonThreadFactory	ThreadFactory that creates daemon threads.
DataSetBuilder<Row extends Comparable,Column extends Comparable>	Builds CategoryDataset.
DecodingStream	Hex-binary decoding stream.
DelegatingOutputStream	Works like FilterOutputStream except its performance problem.
DescribableList<T extends Describable<T>,D extends Descriptor<T>>	Persisted list of Describables with some operations specific to Descriptors.
DescribableList.ConverterImpl	Converter implementation for XStream.
DescriptorList<T extends Describable<T>>	List of Descriptors.
DirScanner	Visits a directory and its contents and pass them to the FileVisitor.
DirScanner.Filter	Scans by filtering things out from FileFilter.
DirScanner.Full	Scans everything recursively.
DirScanner.Glob	Scans by using Ant GLOB syntax.
DoubleLaunchChecker	Makes sure that no other Hudson uses our JENKINS_HOME directory, to forestall the problem of running multiple instances of Hudson that point to the same data directory.
DualOutputStream
EditDistance	Computes the string edit distance.
EncodingStream	Hex-binary encoding stream.
EnumConverter	Converter for enums.
ExceptionCatchingThreadFactory	ThreadFactory that creates a thread, which in turn displays a stack trace when it terminates unexpectedly.
FileChannelWriter	This class has been created to help make AtomicFileWriter hopefully more reliable in some corner cases.
FileVisitor	Visits files in a directory recursively.
FlushProofOutputStream	OutputStream that blocks FlushProofOutputStream.flush() method.
ForkOutputStream
FormApply	Server-side code related to the <f:apply> button.
FormFieldValidator	Deprecated. as of 1.294 Use FormValidation as a return value in your check method.
FormFieldValidator.Base64	Deprecated. as of 1.305 Use FormValidation.validateBase64(String, boolean, boolean, String) instead.
FormFieldValidator.Executable	Deprecated. as of 1.294.
FormFieldValidator.HudsonURL	Checks if the given value is an URL to some Hudson's top page.
FormFieldValidator.NonNegativeInteger	Deprecated. as of 1.294 Use FormValidation.validateNonNegativeInteger(String)
FormFieldValidator.URLCheck	Deprecated. as of 1.294 Use FormValidation.URLCheck
FormFieldValidator.WorkspaceDirectory	Deprecated. as of 1.294.
FormFieldValidator.WorkspaceFileMask	Deprecated. as of 1.294.
FormFieldValidator.WorkspaceFilePath	Deprecated. as of 1.294.
FormValidation.CheckMethod	Builds up the check URL for the client-side JavaScript to call back.
FormValidation.FileValidator	Performs an application-specific validation on the given file.
FormValidation.URLCheck	Convenient base class for checking the validity of URLs.
Futures	Various Future implementations.
Graph	A JFreeChart-generated graph that's bound to UI.
HeadBufferingStream	FilterInputStream that buffers the first N bytes to a byte array on the side.
HeapSpaceStringConverter	Up to XStream 1.3 the default StringConverter in XStream used String.intern(), which stressed the (rather limited) PermGen space with a large XML file.
HexBinaryConverter
HistoricalSecrets	Historical algorithms for decrypting Secrets.
HttpResponses	Various HttpResponse implementations.
HudsonIsLoading	Model object used to display "Jenkins is loading data".
HudsonIsRestarting	Model object used to display "Hudson is restarting".
InterceptingProxy	Creates a proxy that traps every method call.
IOUtils	Adds more to commons-io.
Iterators	Varios Iterator implementations.
Iterators.DuplicateFilterIterator<T>	Remove duplicates from another iterator.
Iterators.FilterIterator<T>	Creates a filtered view of another iterator.
Iterators.FlattenIterator<U,T>	Produces {A,B,C,D,E,F} from {{A,B},{C},{},{D,E,F}}.
JVMBuilder	Used to build up launch parameters for a Java virtual machine.
KeyedDataStorage<T,P>	Convenient base class for implementing data storage.
LineEndingConversion	Converts line endings of a string.
ListBoxModel	Model object of dynamically filled list box.
ListBoxModel.Option
LogTaskListener	TaskListener which sends messages to a Logger.
LRUStringConverter
MaskingClassLoader	ClassLoader that masks a specified set of classes from its parent class loader.
Messages	Generated localization support class.
MultipartFormDataParser	Wraps commons file-upload and handles a "multipart/form-data" form submission (that often includes file upload.)
NamingThreadFactory	Thread factory that sets thread name so we know who is responsible for so many threads being created.
NoClientBindProtocolSocketFactory	A SecureProtocolSocketFactory that creates sockets without binding to a specific interface.
NoClientBindSSLProtocolSocketFactory	A SecureProtocolSocketFactory that creates sockets without binding to a specific interface.
NoOverlapCategoryAxis	This class implements X-axis label skipping algorithm to avoid drawing overlapping labels.
NullStream
OneShotEvent	Concurrency primitive.
PackedMap<K,V>	Read-only map implementation that uses less memory than HashMap/TreeMap.
PackedMap.ConverterImpl	Should persist like a regular map.
PersistedList<T>	Collection whose change is notified to the parent object for persistence.
PersistedList.ConverterImpl	Converter implementation for XStream.
PluginServletFilter	Servlet Filter that chains multiple Filters, provided by plugins
ProcessKiller	Extension point that defines more elaborate way of killing processes, such as sudo or pfexec, for ProcessTree.
ProcessKillingVeto	Allows extensions to veto killing processes.
ProcessKillingVeto.VetoCause	Describes the cause for a process killing veto.
ProcessTree	Represents a snapshot of the process tree of the current system.
ProcessTree.Local	Represents a local process tree, where this JVM and the process tree run on the same system.
ProcessTree.Remote	Represents a process tree over a channel.
ProcessTreeRemoting	Remoting interfaces of ProcessTree.
Protector	Encrypt/decrypt data by using a "session" key that only lasts for the duration of the server instance.
QueryParameterMap	Parses the query string of the URL into a key/value pair.
ReflectionUtils	Utility code for reflection.
ReflectionUtils.Parameter
RemotingDiagnostics	Various remoting operations related to diagnostics.
RemotingDiagnostics.HeapDump	Heap dump, exposable to URL via Stapler.
Retrier<V>	This class implements a process of doing some action repeatedly synchronously until it is performed successfully.
Retrier.Builder<V>	Builder to create a Retrier object.
RingBufferLogHandler	Log Handler that stores the log records into a ring buffer.
RobustCollectionConverter	CollectionConverter that ignores XStreamException.
RobustReflectionConverter	Custom ReflectionConverter that handle errors more gracefully.
RunList<R extends Run>	List of Runs, sorted in the descending date order.
Scrambler	Scrambles, but does not encrypt, text.
Secret	Glorified String that uses encryption in the persisted form, to avoid accidental exposure of a secret.
Secret.ConverterImpl
SecretRewriter	Rewrites XML files by looking for Secrets that are stored with the old key and replaces them by the new encrypted values.
SequentialExecutionQueue	Executor that collapses two equal Runnables into one, and makes sure no two equal Runnables get executed simultaneously.
Service	Deprecated. use ServiceLoader instead.
ShiftedCategoryAxis	CategoryAxis shifted to left to eliminate redundant space between area and the Y-axis.
StackedAreaRenderer2	Modified StackedAreaRenderer.
StreamCopyThread	Thread that copies InputStream to OutputStream.
StreamResource	Wraps InputStream to Resource.
StreamTaskListener	TaskListener that generates output into a single stream.
TableNestChecker	XMLFilter that checks the proper nesting of table related tags.
TagCloud<T>	Represents an order-preserving tag cloud where each keyword gets a weight and displayed according to their weight.
TextFile	Represents a text file.
UnbufferedBase64InputStream	Deprecated. Use Base64.Decoder.wrap(java.io.InputStream).
VariableResolver.ByMap<V>	VariableResolver backed by a Map.
VariableResolver.Union<V>	Union of multiple VariableResolver.
XStream2	XStream customized in various ways for Jenkins’ needs.
XStream2.PassthruConverter<T>	Create a nested ConverterImpl subclass that extends this class to run some callback code just after a type is unmarshalled by RobustReflectionConverter.
XStream2SecurityUtils	Strongly inspired by https://github.com/x-stream/xstream/blob/61a00fa225dc99488013869b57b772af8e2fea03/xstream/src/java/com/thoughtworks/xstream/core/SecurityUtils.java#L25 and taking into account https://github.com/x-stream/xstream/issues/282 Once the related issue is fixed, we will be able to use the regular method from XStream.

Enum Summary

Enum	Description
FormValidation.Kind	Indicates the kind of result.
LineEndingConversion.EOLType	Supported line ending types for conversion
TimeUnit2	Deprecated. use TimeUnit.

Exception Summary

Exception	Description
AWTProblem
BootFailure	Indicates a fatal boot problem, among ErrorObject
CyclicGraphDetector.CycleDetectedException
ErrorObject	Basis for error model objects.
FormFillFailure	Represents a failure in a form field doFillXYZ method.
FormValidation	Represents the result of the form field validation.
HudsonFailedToLoad	Model object used to display the generic error when Jenkins start up fails fatally during initialization.
IncompatibleAntVersionDetected	Model object used to display the error top page if we find out that the container is picking up its own Ant and that's not 1.7.
IncompatibleServletVersionDetected	Model object used to display the error top page if we find out that the container doesn't support servlet 2.4.
IncompatibleVMDetected	Model object used to display the error top page if we find out that XStream is running in pure-java mode.
InsufficientPermissionDetected	Model object used to display the error top page if we find that we don't have enough permissions to run.
IOException2	Deprecated. Just use IOException, which since Java 6 supports a cause.
JenkinsReloadFailed	Indicates that Jenkins is interrupted during reload.
NoHomeDir	Model object used to display the error top page if we couldn't create the home directory.
NoTempDir	Model object used to display the error top page if there appears to be no temporary directory.
RobustReflectionConverter.DuplicateFieldException