Package com.coveo.pushapiclient

Class UserSecurityIdentityBuilder

java.lang.Object

com.coveo.pushapiclient.UserSecurityIdentityBuilder

All Implemented Interfaces:

SecurityIdentityBuilder

public class UserSecurityIdentityBuilder
extends Object
implements SecurityIdentityBuilder

Build a security identity of type `USER`.

Typically used in conjunction with DocumentBuilder.withAllowedPermissions(com.coveo.pushapiclient.SecurityIdentityBuilder) or DocumentBuilder.withDeniedPermissions(com.coveo.pushapiclient.SecurityIdentityBuilder).

See SecurityIdentity.

Constructor Summary

Constructors

Constructor	Description
UserSecurityIdentityBuilder(String identity)	Construct a UserSecurityIdentityBuilder for a single identity with an `Email Security Provider`.
UserSecurityIdentityBuilder(String[] identities)	Construct a UserSecurityIdentityBuilder for multiple identities with an `Email Security Provider`.
UserSecurityIdentityBuilder(String[] identities, String securityProvider)
UserSecurityIdentityBuilder(String identity, String securityProvider)	Construct a UserSecurityIdentityBuilder for a single identity with the given security provider.

Method Summary

Modifier and Type	Method	Description
SecurityIdentity[]	build()	Build and return a list of SecurityIdentity
boolean	equals(Object obj)
String[]	getIdentities()
String	getSecurityProvider()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

UserSecurityIdentityBuilder

public UserSecurityIdentityBuilder(String[] identities,
 String securityProvider)

UserSecurityIdentityBuilder

public UserSecurityIdentityBuilder(String identity,
 String securityProvider)

Construct a UserSecurityIdentityBuilder for a single identity with the given security provider.

Parameters:

identity -

securityProvider -

UserSecurityIdentityBuilder

public UserSecurityIdentityBuilder(String identity)

Construct a UserSecurityIdentityBuilder for a single identity with an `Email Security Provider`.

Parameters:

identity -

UserSecurityIdentityBuilder

public UserSecurityIdentityBuilder(String[] identities)

Construct a UserSecurityIdentityBuilder for multiple identities with an `Email Security Provider`.

Parameters:

identities -

Method Details

build

public SecurityIdentity[] build()

Description copied from interface: SecurityIdentityBuilder

Build and return a list of SecurityIdentity

Specified by:

build in interface SecurityIdentityBuilder

Returns:

getIdentities

public String[] getIdentities()

getSecurityProvider

public String getSecurityProvider()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object