net.shibboleth.metadata.pipeline
Class ComponentInfo

java.lang.Object
  net.shibboleth.metadata.pipeline.ComponentInfo

All Implemented Interfaces:

Serializable, ItemMetadata

public class ComponentInfo
extends Object
implements ItemMetadata

Some basic information related to a component's processing of an Item.

See Also:

Serialized Form

Field Summary

private DateTime	completeInstant Instant when the component operation completed.
private String	componentId ID of the component that operated on the element.
private Class<?>	componentType Gets the type of the component that operated on the element.
private static long	serialVersionUID Serial version UID.
private DateTime	startInstant Instant when the component operation started.

Constructor Summary

ComponentInfo()
Constructor.

ComponentInfo(net.shibboleth.utilities.java.support.component.IdentifiableComponent component)
Constructor.

Method Summary

DateTime	getCompleteInstant() Gets the instant when the component operation completed.
String	getComponentId() Gets the ID of the component that operated on the element.
Class<?>	getComponentType() Gets the type of the component that operated on the element.
DateTime	getStartInstant() Gets the instant when the component operation started.
void	setCompleteInstant() Sets the complete instant of the component to now.
void	setCompleteInstant(DateTime instant) Sets the instant when the component operation completed.
void	setComponentId(String id) Sets the ID of the component that operated on the element.
void	setComponentType(Class<?> type) Sets the type of the component that operated on the element.
void	setStartInstant(DateTime instant) Sets the instant when the component operation started.

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

componentId

private String componentId

ID of the component that operated on the element.

componentType

private Class<?> componentType

Gets the type of the component that operated on the element.

startInstant

private DateTime startInstant

Instant when the component operation started.

completeInstant

private DateTime completeInstant

Instant when the component operation completed.

Constructor Detail

ComponentInfo

public ComponentInfo()

Constructor.

ComponentInfo

public ComponentInfo(@Nonnull
                     net.shibboleth.utilities.java.support.component.IdentifiableComponent component)

Constructor. Sets the ID and component type from the given component. Sets the start instant to now.

Parameters:

component - component which this info describes

Method Detail

getComponentId

@Nullable
public String getComponentId()

Gets the ID of the component that operated on the element.

Returns:

ID of the component that operated on the element

setComponentId

public void setComponentId(@Nullable
                           String id)

Sets the ID of the component that operated on the element.

Parameters:

id - ID of the component that operated on the element

getComponentType

@Nullable
public Class<?> getComponentType()

Gets the type of the component that operated on the element.

Returns:

type of the component that operated on the element

setComponentType

public void setComponentType(@Nullable
                             Class<?> type)

Sets the type of the component that operated on the element.

Parameters:

type - type of the component that operated on the element

getStartInstant

@Nullable
public DateTime getStartInstant()

Gets the instant when the component operation started.

Returns:

instant when the component operation started

setStartInstant

public void setStartInstant(@Nullable
                            DateTime instant)

Sets the instant when the component operation started.

Parameters:

instant - instant when the component operation started

getCompleteInstant

@Nullable
public DateTime getCompleteInstant()

Gets the instant when the component operation completed.

Returns:

instant when the component operation completed

setCompleteInstant

public void setCompleteInstant()

Sets the complete instant of the component to now.

setCompleteInstant

public void setCompleteInstant(@Nullable
                               DateTime instant)

Sets the instant when the component operation completed.

Parameters:

instant - when the component operation completed