Package net.shibboleth.metadata

Class StatusMetadata

java.lang.Object

net.shibboleth.metadata.StatusMetadata

All Implemented Interfaces:

ItemMetadata

Direct Known Subclasses:

ErrorStatus, InfoStatus, WarningStatus

@Immutable
public abstract sealed class StatusMetadata
extends Object
implements ItemMetadata
permits ErrorStatus, WarningStatus, InfoStatus

A ItemMetadata implementation that carries status information about an Item.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	component	The component that generated this status information.
private final String	message	The message associated with this status.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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 Details

component

@Nonnull
@NotEmpty
private final String component

The component that generated this status information.

message

@Nonnull
@NotEmpty
private final String message

The message associated with this status.

Constructor Details

StatusMetadata

public StatusMetadata(@Nonnull
 String componentId,
 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 Details

getComponentId

@Nonnull
@NotEmpty
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 or empty

getStatusMessage

@Nonnull
@NotEmpty
public String getStatusMessage()

Gets the status message.

Returns:

the status message, never null or empty