Package net.shibboleth.idp.attribute

Class IdPRequestedAttribute

java.lang.Object

net.shibboleth.idp.attribute.IdPAttribute

net.shibboleth.idp.attribute.IdPRequestedAttribute

All Implemented Interfaces:

Cloneable, Comparable<IdPAttribute>

public final class IdPRequestedAttribute
extends IdPAttribute

IdP Representation of the SAML2 RequestedAttribute.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isRequired	Is this attribute required.

Constructor Summary

Constructors

Constructor	Description
IdPRequestedAttribute(String attributeId)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	getIsRequired()	Deprecated, for removal: This API element is subject to removal in a future version. remove in V5
boolean	isRequired()	Is this attribute marked as required?
void	setRequired(boolean required)	Set whether this attribute is to be marked as required.

Methods inherited from class net.shibboleth.idp.attribute.IdPAttribute

clone, compareTo, equals, getDisplayDescriptions, getDisplayNames, getId, getValues, hashCode, isDeprecatedId, isInvalidId, setDisplayDescriptions, setDisplayNames, setValues, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

isRequired

private boolean isRequired

Is this attribute required.

Constructor Details

IdPRequestedAttribute

public IdPRequestedAttribute(@ParameterName(name="attributeId")
String attributeId)

Constructor.

Parameters:

attributeId - the id

Method Details

isRequired

public boolean isRequired()

Is this attribute marked as required?

Returns:

the isRequired flag

Since:

4.0.0

getIsRequired

@Deprecated(forRemoval=true,
            since="4.0.0")
public boolean getIsRequired()

Deprecated, for removal: This API element is subject to removal in a future version.

remove in V5

Is this attribute marked as required?

Returns:

the isRequired flag

setRequired

public void setRequired(boolean required)

Set whether this attribute is to be marked as required.

Parameters:

required - The flag to set.