Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2016 Michael Krotscheck
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package net.krotscheck.kangaroo.authz.common.database.entity;
import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.JsonIdentityReference;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonView;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.swagger.annotations.ApiModelProperty;
import net.krotscheck.kangaroo.authz.common.authenticator.AuthenticatorType;
import net.krotscheck.kangaroo.authz.common.database.jackson.Views;
import net.krotscheck.kangaroo.common.hibernate.id.AbstractEntityReferenceDeserializer;
import org.hibernate.annotations.OnDelete;
import org.hibernate.annotations.OnDeleteAction;
import org.hibernate.search.annotations.Analyze;
import org.hibernate.search.annotations.Analyzer;
import org.hibernate.search.annotations.ContainedIn;
import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.FieldBridge;
import org.hibernate.search.annotations.Index;
import org.hibernate.search.annotations.Indexed;
import org.hibernate.search.annotations.IndexedEmbedded;
import org.hibernate.search.annotations.Store;
import org.hibernate.search.bridge.builtin.EnumBridge;
import javax.persistence.Basic;
import javax.persistence.CascadeType;
import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.MapKeyColumn;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import javax.persistence.Transient;
import javax.validation.constraints.NotNull;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* A user's identity, as provided by authenticators. Note that a user may have
* more than one identity from an authenticator- for instance, a user may link
* to two separate gmail accounts.
*
* @author Michael Krotscheck
*/
@Entity
@Indexed(index = "user_identities")
@Table(name = "user_identities")
@Analyzer(definition = "entity_analyzer")
public final class UserIdentity extends AbstractAuthzEntity {
/**
* The user to whom this identity record belongs.
*/
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "user", nullable = false, updatable = false)
@JsonIdentityReference(alwaysAsId = true)
@JsonIdentityInfo(
generator = ObjectIdGenerators.PropertyGenerator.class,
property = "id")
@JsonDeserialize(using = User.Deserializer.class)
@ContainedIn
@JsonView(Views.Public.class)
@IndexedEmbedded(includePaths = {"id", "application.owner.id"})
@ApiModelProperty(
required = true,
dataType = "string",
example = "3f631a2d6a04f5cc55f9e192f45649b7"
)
private User user;
/**
* The type of this identity, indicating the authenticator type that can
* provide this.
*
* @see {@link Authenticator#type}
*/
@Enumerated(EnumType.STRING)
@Column(name = "type", nullable = false, updatable = false)
@Field(index = Index.YES, analyze = Analyze.YES, store = Store.NO,
bridge = @FieldBridge(impl = EnumBridge.class))
@NotNull
@JsonView(Views.Public.class)
@ApiModelProperty(required = true)
private AuthenticatorType type;
/**
* OAuth tokens issued to this identity.
*/
@OneToMany(
fetch = FetchType.LAZY,
mappedBy = "identity",
cascade = {CascadeType.REMOVE, CascadeType.MERGE},
orphanRemoval = true
)
@JsonIgnore
@OnDelete(action = OnDeleteAction.CASCADE)
@ContainedIn
private List tokens = new ArrayList<>();
/**
* The user's remote ID- the ID by which the authenticator would recognize
* this user.
*/
@Basic(optional = false)
@Column(name = "remoteId", nullable = false, updatable = false)
@Field(index = Index.YES, analyze = Analyze.YES, store = Store.NO)
@JsonView(Views.Public.class)
@ApiModelProperty(required = true)
private String remoteId;
/**
* The claims about the identity of this user, made by the authenticator.
*/
@ElementCollection(fetch = FetchType.EAGER)
@CollectionTable(name = "user_identity_claims",
joinColumns = @JoinColumn(name = "user_identity"))
@MapKeyColumn(name = "claimKey")
@Column(name = "claimValue")
@Field(name = "claims",
index = Index.YES, analyze = Analyze.YES, store = Store.NO)
@IndexedEmbedded
@JsonView(Views.Public.class)
private Map claims = new HashMap<>();
/**
* The user's password salt.
*/
@Basic
@Column(name = "salt")
@JsonView(Views.Secure.class)
@ApiModelProperty()
private String salt;
/**
* The user's hashed password.
*/
@Basic
@Column(name = "password")
@JsonView(Views.Secure.class)
private String password;
/**
* Get the user record for this identity.
*
* @return The user record.
*/
public User getUser() {
return user;
}
/**
* Set the user for this identity.
*
* @param user This identity's user.
*/
public void setUser(final User user) {
this.user = user;
}
/**
* The remote ID by which the authenticator recognizes the user.
*
* @return A string, representing this authenticator.
*/
public String getRemoteId() {
return remoteId;
}
/**
* Set the remote ID by which the authenticator recognizes the user.
*
* @param remoteId The remote ID.
*/
public void setRemoteId(final String remoteId) {
this.remoteId = remoteId;
}
/**
* Retrieve identity claims made by the authenticator.
*
* @return A set of claims, such as email and name.
*/
public Map getClaims() {
return claims;
}
/**
* Set the claims made by the authenticator.
*
* @param claims The claims.
*/
public void setClaims(final Map claims) {
this.claims = new HashMap<>(claims);
}
/**
* The type of authenticator.
*
* @return The authenticator type.
*/
public AuthenticatorType getType() {
return type;
}
/**
* Set the type of authenticator.
*
* @param authType The new authType.
*/
public void setType(final AuthenticatorType authType) {
this.type = authType;
}
/**
* Get all the tokens issued to this identity.
*
* @return A list of all tokens (lazy loaded)
*/
public List getTokens() {
return tokens;
}
/**
* Set the list of tokens for this user.
*
* @param tokens A new list of tokens.
*/
public void setTokens(final List tokens) {
this.tokens = new ArrayList<>(tokens);
}
/**
* Get the salt.
*
* @return The current salt.
*/
public String getSalt() {
return salt;
}
/**
* Set a new salt.
*
* @param salt A new salt, should be 32 characters long.
*/
public void setSalt(final String salt) {
this.salt = salt;
}
/**
* Get the password.
*
* @return An encrypted password.
*/
public String getPassword() {
return password;
}
/**
* Set a new password. Make sure this is encrypted first.
*
* @param password The new password.
*/
public void setPassword(final String password) {
this.password = password;
}
/**
* The owner of this entity.
*
* @return This entity's owner, if it exists.
*/
@Override
@Transient
@JsonIgnore
public User getOwner() {
if (user != null) {
return user.getOwner();
}
return null;
}
/**
* Deserialize a reference to an User.
*
* @author Michael Krotschecks
*/
public static final class Deserializer
extends AbstractEntityReferenceDeserializer {
/**
* Constructor.
*/
public Deserializer() {
super(UserIdentity.class);
}
}
}
