com.atlassian.plugins.whitelist

Class ImmutableWhitelistRule

java.lang.Object

com.atlassian.plugins.whitelist.ImmutableWhitelistRule

All Implemented Interfaces:

WhitelistRule, Serializable

@Immutable
 @PublicApi
public final class ImmutableWhitelistRule
extends Object
implements WhitelistRule, Serializable

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableWhitelistRule(ImmutableWhitelistRuleBuilder builder)
ImmutableWhitelistRule(WhitelistRule copy)

Method Summary

Modifier and Type	Method and Description
static ImmutableWhitelistRuleBuilder	builder()
boolean	equals(Object o)
String	getExpression()
Integer	getId()
WhitelistType	getType()
int	hashCode()
boolean	isAllowInbound()
boolean	isAuthenticationRequired()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableWhitelistRule

public ImmutableWhitelistRule(ImmutableWhitelistRuleBuilder builder)

ImmutableWhitelistRule

public ImmutableWhitelistRule(WhitelistRule copy)

Method Detail

builder

public static ImmutableWhitelistRuleBuilder builder()

getId

public Integer getId()

Specified by:

getId in interface WhitelistRule

Returns:

the id of the whitelist rule; null if not yet persisted

getExpression

public String getExpression()

Specified by:

getExpression in interface WhitelistRule

Returns:

an whitelist rule expression; can have a specific meaning depending on the type.

getType

public WhitelistType getType()

Specified by:

getType in interface WhitelistRule

Returns:

the whitelist rule type

isAllowInbound

public boolean isAllowInbound()

Specified by:

isAllowInbound in interface WhitelistRule

Returns:

true if the whitelist rule represents inbound requests as well as outbound requests, false otherwise

isAuthenticationRequired

public boolean isAuthenticationRequired()

Specified by:

isAuthenticationRequired in interface WhitelistRule

Returns:

true if the whitelist rule requires the user to be authenticated, false otherwise

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object