Package alpine.model

Class ApiKey

java.lang.Object

alpine.model.ApiKey

All Implemented Interfaces:

Serializable, Principal

public class ApiKey
extends Object
implements Serializable, Principal

Persistable object representing an ApiKey.

Since:

1.0.0

Author:

Steve Springett

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ApiKey()

Method Summary

Modifier and Type	Method	Description
long	getId()
String	getKey()
String	getMaskedKey()	Masks all key characters except the prefix and last four characters with *.
String	getName()	Deprecated. use UserPrincipal.getUsername()
List<Team>	getTeams()
void	setId(long id)
void	setKey(String key)
void	setTeams(List<Team> teams)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Constructor Details

ApiKey

public ApiKey()

Method Details

getId

public long getId()

setId

public void setId(long id)

getKey

public String getKey()

setKey

public void setKey(String key)

getMaskedKey

public String getMaskedKey()

Masks all key characters except the prefix and last four characters with *. If the key does not have the currently configured prefix, do not return it.

Returns:

Masked key.

getName

@Deprecated
public String getName()

Deprecated.

use UserPrincipal.getUsername()

Do not use - only here to satisfy Principal implementation requirement.

Specified by:

getName in interface Principal

Returns:

a String presentation of the username

getTeams

public List<Team> getTeams()

setTeams

public void setTeams(List<Team> teams)