org.keycloak.events.admin.AdminEvent Maven / Gradle / Ivy
/*
* Copyright 2016 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* 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 org.keycloak.events.admin;
/**
* @author Stian Thorgersen
*/
public class AdminEvent {
private long time;
private String realmId;
private AuthDetails authDetails;
/**
* The resource type an AdminEvent was triggered for.
*/
private ResourceType resourceType;
private OperationType operationType;
private String resourcePath;
private String representation;
private String error;
/**
* Returns the time of the event
*
* @return time in millis
*/
public long getTime() {
return time;
}
public void setTime(long time) {
this.time = time;
}
/**
* Returns the id of the realm
*
* @return
*/
public String getRealmId() {
return realmId;
}
public void setRealmId(String realmId) {
this.realmId = realmId;
}
/**
* Returns authentication details
*
* @return
*/
public AuthDetails getAuthDetails() {
return authDetails;
}
public void setAuthDetails(AuthDetails authDetails) {
this.authDetails = authDetails;
}
/**
* Returns the type of the operation
*
* @return
*/
public OperationType getOperationType() {
return operationType;
}
public void setOperationType(OperationType operationType) {
this.operationType = operationType;
}
/**
* Returns the path of the resource. For example:
*
* - realms - realm list
* - realms/master - master realm
* - realms/clients/00d4b16f-f1f9-4e73-8366-d76b18f3e0e1 - client within the master realm
*
*
* @return
*/
public String getResourcePath() {
return resourcePath;
}
public void setResourcePath(String resourcePath) {
this.resourcePath = resourcePath;
}
/**
* Returns the updated JSON representation if operationType is CREATE or UPDATE.
* Otherwise returns null.
*
* @return
*/
public String getRepresentation() {
return representation;
}
public void setRepresentation(String representation) {
this.representation = representation;
}
/**
* If the event was unsuccessful returns the error message. Otherwise returns null.
*
* @return
*/
public String getError() {
return error;
}
public void setError(String error) {
this.error = error;
}
/**
* Returns the type of the affected {@link ResourceType} for this {@link AdminEvent}, e.g. {@link ResourceType#USER USER}, {@link ResourceType#GROUP GROUP} etc.
*
* @return
*/
public ResourceType getResourceType() {
return resourceType;
}
public void setResourceType(ResourceType resourceType) {
this.resourceType = resourceType;
}
}