net.shibboleth.metadata

Class StatusMetadata

java.lang.Object

net.shibboleth.metadata.StatusMetadata

All Implemented Interfaces:

Serializable, ItemMetadata

Direct Known Subclasses:

ErrorStatus, InfoStatus, WarningStatus

public class StatusMetadata
extends Object
implements ItemMetadata

A ItemMetadata implementation that carries status information about an Item.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private String	component The component that generated this status information.
private String	message The message associated with this status.
private static long	serialVersionUID Serial version UID.

Constructor Summary

Constructors

Constructor and Description
StatusMetadata(String componentId, String statusMessage) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentId() Gets the ID of the component that generated the status message.
String	getStatusMessage() Gets the status message.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version UID.

See Also:

Constant Field Values

component

private final String component

The component that generated this status information.

message

private final String message

The message associated with this status.

Constructor Detail

StatusMetadata

public StatusMetadata(@Nonnull@NotEmpty
              String componentId,
              @Nonnull@NotEmpty
              String statusMessage)

Constructor.

Parameters:

componentId - ID of the component creating the status message, never null or empty

statusMessage - the status message, never null or empty

Method Detail

getComponentId

@Nonnull
public String getComponentId()

Gets the ID of the component that generated the status message.

Returns:

ID of the component that generated the status message, never null

getStatusMessage

@Nonnull
public String getStatusMessage()

Gets the status message.

Returns:

the status message, never null