org.keycloak.models.UserSessionModel 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.models;
import java.util.List;
import java.util.Map;
/**
* @author Stian Thorgersen
*/
public interface UserSessionModel {
String getId();
RealmModel getRealm();
/**
* If created via a broker external login, this is an identifier that can be
* used to match external broker backchannel logout requests to a UserSession
*
* @return
*/
String getBrokerSessionId();
String getBrokerUserId();
UserModel getUser();
String getLoginUsername();
String getIpAddress();
String getAuthMethod();
boolean isRememberMe();
int getStarted();
int getLastSessionRefresh();
void setLastSessionRefresh(int seconds);
List getClientSessions();
public String getNote(String name);
public void setNote(String name, String value);
public void removeNote(String name);
public Map getNotes();
State getState();
void setState(State state);
public static enum State {
LOGGING_IN,
LOGGED_IN,
LOGGING_OUT,
LOGGED_OUT
}
}