org.keycloak.storage.client.ClientStorageProviderModel クラス

org.keycloak.storage.client.ClientStorageProviderModel の継承関係図

org.keycloak.storage.client.ClientStorageProviderModel 連携図

公開メンバ関数
	ClientStorageProviderModel ()
	ClientStorageProviderModel (ComponentModel copy)
void	setEnabled (boolean flag)
boolean	isEnabled ()
CachePolicy	getCachePolicy ()
void	setCachePolicy (CachePolicy cachePolicy)
long	getMaxLifespan ()
void	setMaxLifespan (long maxLifespan)
int	getEvictionHour ()
void	setEvictionHour (int evictionHour)
int	getEvictionMinute ()
void	setEvictionMinute (int evictionMinute)
int	getEvictionDay ()
void	setEvictionDay (int evictionDay)
long	getCacheInvalidBefore ()
void	setCacheInvalidBefore (long cacheInvalidBefore)
long	getLifespan ()
boolean	shouldInvalidate (CachedObject cached)
int	getPriority ()
void	setPriority (int priority)
String	getId ()
void	setId (String id)
String	getName ()
void	setName (String name)
MultivaluedHashMap< String, String >	getConfig ()
void	setConfig (MultivaluedHashMap< String, String > config)
boolean	contains (String key)
String	get (String key)
String	get (String key, String defaultValue)
int	get (String key, int defaultValue)
long	get (String key, long defaultValue)
boolean	get (String key, boolean defaultValue)
void	put (String key, String value)
void	put (String key, int value)
void	put (String key, long value)
void	put (String key, boolean value)
boolean	hasNote (String key)
void	setNote (String key, Object object)
String	getProviderId ()
void	setProviderId (String providerId)
String	getProviderType ()
void	setProviderType (String providerType)
String	getParentId ()
void	setParentId (String parentId)
String	getSubType ()
void	setSubType (String subType)

静的公開メンバ関数
static long	dailyTimeout (int hour, int minute)
static long	dailyEvictionBoundary (int hour, int minute)
static long	weeklyTimeout (int day, int hour, int minute)
static int	parsePriority (ComponentModel component)

静的公開変数類
static final String	ENABLED = "enabled"
static final String	CACHE_POLICY = "cachePolicy"
static final String	MAX_LIFESPAN = "maxLifespan"
static final String	EVICTION_HOUR = "evictionHour"
static final String	EVICTION_MINUTE = "evictionMinute"
static final String	EVICTION_DAY = "evictionDay"
static final String	CACHE_INVALID_BEFORE = "cacheInvalidBefore"
static final String	PRIORITY = "priority"
static Comparator< ComponentModel >	comparator

関数
public< T > T	getNote (String key)

非公開変数類
transient Boolean	enabled

詳解

Stored configuration of a Client Storage provider instance.

著者

Bill Burke

構築子と解体子

ClientStorageProviderModel() [1/2]

org.keycloak.storage.client.ClientStorageProviderModel.ClientStorageProviderModel ( )

inline

                                        {
        setProviderType(ClientStorageProvider.class.getName());
    }

ClientStorageProviderModel() [2/2]

org.keycloak.storage.client.ClientStorageProviderModel.ClientStorageProviderModel ( ComponentModel  copy )

inline

                                                           {
        super(copy);
    }

関数詳解

contains()

boolean org.keycloak.component.ComponentModel.contains ( String  key )

inlineinherited

                                        {
        return config.containsKey(key);
    }

dailyEvictionBoundary()

static long org.keycloak.storage.CacheableStorageProviderModel.dailyEvictionBoundary ( int  hour, int  minute  )

inlinestaticinherited

                                                                   {
        Calendar cal = Calendar.getInstance();
        cal.setTimeInMillis(Time.currentTimeMillis());
        cal.set(Calendar.HOUR_OF_DAY, hour);
        cal.set(Calendar.MINUTE, minute);
        if (cal.getTimeInMillis() > Time.currentTimeMillis()) {
            // if daily evict for today hasn't happened yet set boundary
            // to yesterday's time of eviction
            cal.add(Calendar.DAY_OF_YEAR, -1);
        }
        return cal.getTimeInMillis();
    }

dailyTimeout()

static long org.keycloak.storage.CacheableStorageProviderModel.dailyTimeout ( int  hour, int  minute  )

inlinestaticinherited

                                                          {
        Calendar cal = Calendar.getInstance();
        Calendar cal2 = Calendar.getInstance();
        cal.setTimeInMillis(Time.currentTimeMillis());
        cal2.setTimeInMillis(Time.currentTimeMillis());
        cal2.set(Calendar.HOUR_OF_DAY, hour);
        cal2.set(Calendar.MINUTE, minute);
        if (cal2.getTimeInMillis() < cal.getTimeInMillis()) {
            int add = (24 * 60 * 60 * 1000);
            cal.add(Calendar.MILLISECOND, add);
        } else {
            cal = cal2;
        }
        return cal.getTimeInMillis();
    }

get() [1/5]

String org.keycloak.component.ComponentModel.get ( String  key )

inlineinherited

                                  {
        return config.getFirst(key);
    }

get() [2/5]

String org.keycloak.component.ComponentModel.get ( String  key, String  defaultValue  )

inlineinherited

                                                       {
        String s = config.getFirst(key);
        return s != null ? s : defaultValue;
    }

get() [3/5]

int org.keycloak.component.ComponentModel.get ( String  key, int  defaultValue  )

inlineinherited

                                                 {
        String s = config.getFirst(key);
        return s != null ? Integer.parseInt(s) : defaultValue;
    }

get() [4/5]

long org.keycloak.component.ComponentModel.get ( String  key, long  defaultValue  )

inlineinherited

                                                   {
        String s = config.getFirst(key);
        return s != null ? Long.parseLong(s) : defaultValue;
    }

get() [5/5]

boolean org.keycloak.component.ComponentModel.get ( String  key, boolean  defaultValue  )

inlineinherited

                                                         {
        String s = config.getFirst(key);
        return s != null ? Boolean.parseBoolean(s) : defaultValue;
    }

getCacheInvalidBefore()

long org.keycloak.storage.CacheableStorageProviderModel.getCacheInvalidBefore ( )

inlineinherited

                                        {
        if (cacheInvalidBefore < 0) {
            String str = getConfig().getFirst(CACHE_INVALID_BEFORE);
            if (str == null) return -1;
            cacheInvalidBefore = Long.valueOf(str);
        }
        return cacheInvalidBefore;
    }

getCachePolicy()

CachePolicy org.keycloak.storage.CacheableStorageProviderModel.getCachePolicy ( )

inlineinherited

                                        {
        if (cachePolicy == null) {
            String str = getConfig().getFirst(CACHE_POLICY);
            if (str == null) return null;
            cachePolicy = CachePolicy.valueOf(str);
        }
        return cachePolicy;
    }

getConfig()

MultivaluedHashMap<String, String> org.keycloak.component.ComponentModel.getConfig ( )

inlineinherited

                                                          {
        return config;
    }

getEvictionDay()

int org.keycloak.storage.CacheableStorageProviderModel.getEvictionDay ( )

inlineinherited

                                {
        if (evictionDay < 0) {
            String str = getConfig().getFirst(EVICTION_DAY);
            if (str == null) return -1;
            evictionDay = Integer.valueOf(str);
        }
        return evictionDay;
    }

getEvictionHour()

int org.keycloak.storage.CacheableStorageProviderModel.getEvictionHour ( )

inlineinherited

                                 {
        if (evictionHour < 0) {
            String str = getConfig().getFirst(EVICTION_HOUR);
            if (str == null) return -1;
            evictionHour = Integer.valueOf(str);
        }
        return evictionHour;
    }

getEvictionMinute()

int org.keycloak.storage.CacheableStorageProviderModel.getEvictionMinute ( )

inlineinherited

                                   {
        if (evictionMinute < 0) {
            String str = getConfig().getFirst(EVICTION_MINUTE);
            if (str == null) return -1;
            evictionMinute = Integer.valueOf(str);
        }
        return evictionMinute;
    }

getId()

String org.keycloak.component.ComponentModel.getId ( )

inlineinherited

                          {
        return id;
    }

getLifespan()

long org.keycloak.storage.CacheableStorageProviderModel.getLifespan ( )

inlineinherited

                              {
        UserStorageProviderModel.CachePolicy policy = getCachePolicy();
        long lifespan = -1;
        if (policy == null || policy == UserStorageProviderModel.CachePolicy.DEFAULT) {
            lifespan = -1;
        } else if (policy == CacheableStorageProviderModel.CachePolicy.EVICT_DAILY) {
            if (getEvictionHour() > -1 && getEvictionMinute() > -1) {
                lifespan = dailyTimeout(getEvictionHour(), getEvictionMinute()) - Time.currentTimeMillis();
            }
        } else if (policy == CacheableStorageProviderModel.CachePolicy.EVICT_WEEKLY) {
            if (getEvictionDay() > 0 && getEvictionHour() > -1 && getEvictionMinute() > -1) {
                lifespan = weeklyTimeout(getEvictionDay(), getEvictionHour(), getEvictionMinute()) - Time.currentTimeMillis();
            }
        } else if (policy == CacheableStorageProviderModel.CachePolicy.MAX_LIFESPAN) {
            lifespan = getMaxLifespan();
        }
        return lifespan;
    }

getMaxLifespan()

long org.keycloak.storage.CacheableStorageProviderModel.getMaxLifespan ( )

inlineinherited

                                 {
        if (maxLifespan < 0) {
            String str = getConfig().getFirst(MAX_LIFESPAN);
            if (str == null) return -1;
            maxLifespan = Long.valueOf(str);
        }
        return maxLifespan;
    }

getName()

String org.keycloak.component.ComponentModel.getName ( )

inlineinherited

                            {
        return name;
    }

getNote()

public<T> T org.keycloak.component.ComponentModel.getNote ( String  key )

inlinepackageinherited

                                     {
        return (T) notes.get(key);
    }

getParentId()

String org.keycloak.component.ComponentModel.getParentId ( )

inlineinherited

                                {
        return parentId;
    }

getPriority()

int org.keycloak.component.PrioritizedComponentModel.getPriority ( )

inlineinherited

                             {
        return parsePriority(this);

    }

getProviderId()

String org.keycloak.component.ComponentModel.getProviderId ( )

inlineinherited

                                  {
        return providerId;
    }

getProviderType()

String org.keycloak.component.ComponentModel.getProviderType ( )

inlineinherited

                                    {
        return providerType;
    }

getSubType()

String org.keycloak.component.ComponentModel.getSubType ( )

inlineinherited

                               {
        return subType;
    }

hasNote()

boolean org.keycloak.component.ComponentModel.hasNote ( String  key )

inlineinherited

                                       {
        return notes.containsKey(key);
    }

isEnabled()

boolean org.keycloak.storage.client.ClientStorageProviderModel.isEnabled ( )

inline

                               {
        if (enabled == null) {
            String val = getConfig().getFirst(ENABLED);
            if (val == null) {
                enabled = true;
            } else {
                enabled = Boolean.valueOf(val);
            }
        }
        return enabled;

    }

parsePriority()

static int org.keycloak.component.PrioritizedComponentModel.parsePriority ( ComponentModel  component )

inlinestaticinherited

                                                              {
        String priority = component.getConfig().getFirst(PRIORITY);
        if (priority == null) return 0;
        return Integer.valueOf(priority);

    }

put() [1/4]

void org.keycloak.component.ComponentModel.put ( String  key, String  value  )

inlineinherited

                                              {
        config.putSingle(key, value);
    }

put() [2/4]

void org.keycloak.component.ComponentModel.put ( String  key, int  value  )

inlineinherited

                                           {
        config.putSingle(key, Integer.toString(value));
    }

put() [3/4]

void org.keycloak.component.ComponentModel.put ( String  key, long  value  )

inlineinherited

                                            {
        config.putSingle(key, Long.toString(value));
    }

put() [4/4]

void org.keycloak.component.ComponentModel.put ( String  key, boolean  value  )

inlineinherited

                                               {
        config.putSingle(key, Boolean.toString(value));
    }

setCacheInvalidBefore()

void org.keycloak.storage.CacheableStorageProviderModel.setCacheInvalidBefore ( long  cacheInvalidBefore )

inlineinherited

                                                               {
        this.cacheInvalidBefore = cacheInvalidBefore;
        getConfig().putSingle(CACHE_INVALID_BEFORE, Long.toString(cacheInvalidBefore));
    }

setCachePolicy()

void org.keycloak.storage.CacheableStorageProviderModel.setCachePolicy ( CachePolicy  cachePolicy )

inlineinherited

                                                        {
        this.cachePolicy = cachePolicy;
        if (cachePolicy == null) {
            getConfig().remove(CACHE_POLICY);

        } else {
            getConfig().putSingle(CACHE_POLICY, cachePolicy.name());
        }
    }

setConfig()

void org.keycloak.component.ComponentModel.setConfig ( MultivaluedHashMap< String, String >  config )

inlineinherited

                                                                     {
        this.config = config;
    }

setEnabled()

void org.keycloak.storage.client.ClientStorageProviderModel.setEnabled ( boolean  flag )

inline

                                          {
        enabled = flag;
        getConfig().putSingle(ENABLED, Boolean.toString(flag));
    }

setEvictionDay()

void org.keycloak.storage.CacheableStorageProviderModel.setEvictionDay ( int  evictionDay )

inlineinherited

                                                {
        if (evictionDay > 7 || evictionDay < 1) throw new IllegalArgumentException("Must be between 1 and 7");
        this.evictionDay = evictionDay;
        getConfig().putSingle(EVICTION_DAY, Integer.toString(evictionDay));
    }

setEvictionHour()

void org.keycloak.storage.CacheableStorageProviderModel.setEvictionHour ( int  evictionHour )

inlineinherited

                                                  {
        if (evictionHour > 23 || evictionHour < 0) throw new IllegalArgumentException("Must be between 0 and 23");
        this.evictionHour = evictionHour;
        getConfig().putSingle(EVICTION_HOUR, Integer.toString(evictionHour));
    }

setEvictionMinute()

void org.keycloak.storage.CacheableStorageProviderModel.setEvictionMinute ( int  evictionMinute )

inlineinherited

                                                      {
        if (evictionMinute > 59 || evictionMinute < 0) throw new IllegalArgumentException("Must be between 0 and 59");
        this.evictionMinute = evictionMinute;
        getConfig().putSingle(EVICTION_MINUTE, Integer.toString(evictionMinute));
    }

setId()

void org.keycloak.component.ComponentModel.setId ( String  id )

inlineinherited

                                 {
        this.id = id;
    }

setMaxLifespan()

void org.keycloak.storage.CacheableStorageProviderModel.setMaxLifespan ( long  maxLifespan )

inlineinherited

                                                 {
        this.maxLifespan = maxLifespan;
        getConfig().putSingle(MAX_LIFESPAN, Long.toString(maxLifespan));
    }

setName()

void org.keycloak.component.ComponentModel.setName ( String  name )

inlineinherited

                                     {
        this.name = name;
    }

setNote()

void org.keycloak.component.ComponentModel.setNote ( String  key, Object  object  )

inlineinherited

                                                   {
        notes.put(key, object);
    }

setParentId()

void org.keycloak.component.ComponentModel.setParentId ( String  parentId )

inlineinherited

                                             {
        this.parentId = parentId;
    }

setPriority()

void org.keycloak.component.PrioritizedComponentModel.setPriority ( int  priority )

inlineinherited

                                          {
        getConfig().putSingle("priority", Integer.toString(priority));
    }

setProviderId()

void org.keycloak.component.ComponentModel.setProviderId ( String  providerId )

inlineinherited

                                                 {
        this.providerId = providerId;
    }

setProviderType()

void org.keycloak.component.ComponentModel.setProviderType ( String  providerType )

inlineinherited

                                                     {
        this.providerType = providerType;
    }

setSubType()

void org.keycloak.component.ComponentModel.setSubType ( String  subType )

inlineinherited

                                           {
        this.subType = subType;
    }

shouldInvalidate()

boolean org.keycloak.storage.CacheableStorageProviderModel.shouldInvalidate ( CachedObject  cached )

inlineinherited

                                                         {
        boolean invalidate = false;
        if (!isEnabled()) {
            invalidate = true;
        } else {
            CacheableStorageProviderModel.CachePolicy policy = getCachePolicy();
            if (policy != null) {
                //String currentTime = DateFormat.getDateTimeInstance(DateFormat.FULL, DateFormat.FULL).format(new Date(Time.currentTimeMillis()));
                if (policy == CacheableStorageProviderModel.CachePolicy.NO_CACHE) {
                    invalidate = true;
                } else if (cached.getCacheTimestamp() < getCacheInvalidBefore()) {
                    invalidate = true;
                } else if (policy == CacheableStorageProviderModel.CachePolicy.MAX_LIFESPAN) {
                    if (cached.getCacheTimestamp() + getMaxLifespan() < Time.currentTimeMillis()) {
                        invalidate = true;
                    }
                } else if (policy == CacheableStorageProviderModel.CachePolicy.EVICT_DAILY) {
                    long dailyBoundary = dailyEvictionBoundary(getEvictionHour(), getEvictionMinute());
                    if (cached.getCacheTimestamp() <= dailyBoundary) {
                        invalidate = true;
                    }
                } else if (policy == CacheableStorageProviderModel.CachePolicy.EVICT_WEEKLY) {
                    int oneWeek = 7 * 24 * 60 * 60 * 1000;
                    long weeklyTimeout = weeklyTimeout(getEvictionDay(), getEvictionHour(), getEvictionMinute());
                    long lastTimeout = weeklyTimeout - oneWeek;
                    //String timeout = DateFormat.getDateTimeInstance(DateFormat.FULL, DateFormat.FULL).format(new Date(weeklyTimeout));
                    //String stamp = DateFormat.getDateTimeInstance(DateFormat.FULL, DateFormat.FULL).format(new Date(cached.getCacheTimestamp()));
                    if (cached.getCacheTimestamp() <= lastTimeout) {
                        invalidate = true;
                    }
                }
            }
        }
        return invalidate;
    }

weeklyTimeout()

static long org.keycloak.storage.CacheableStorageProviderModel.weeklyTimeout ( int  day, int  hour, int  minute  )

inlinestaticinherited

                                                                    {
        Calendar cal = Calendar.getInstance();
        Calendar cal2 = Calendar.getInstance();
        cal.setTimeInMillis(Time.currentTimeMillis());
        cal2.setTimeInMillis(Time.currentTimeMillis());
        cal2.set(Calendar.HOUR_OF_DAY, hour);
        cal2.set(Calendar.MINUTE, minute);
        cal2.set(Calendar.DAY_OF_WEEK, day);
        if (cal2.getTimeInMillis() < cal.getTimeInMillis()) {
            int add = (7 * 24 * 60 * 60 * 1000);
            cal2.add(Calendar.MILLISECOND, add);
        }

        return cal2.getTimeInMillis();
    }

メンバ詳解

CACHE_INVALID_BEFORE

final String org.keycloak.storage.CacheableStorageProviderModel.CACHE_INVALID_BEFORE = "cacheInvalidBefore"

staticinherited

CACHE_POLICY

final String org.keycloak.storage.CacheableStorageProviderModel.CACHE_POLICY = "cachePolicy"

staticinherited

comparator

Comparator<ComponentModel> org.keycloak.component.PrioritizedComponentModel.comparator

staticinherited

初期値:

= new Comparator<ComponentModel>() {
        @Override
        public int compare(ComponentModel o1, ComponentModel o2) {
            return parsePriority(o1) - parsePriority(o2);
        }
    }

ENABLED

final String org.keycloak.storage.client.ClientStorageProviderModel.ENABLED = "enabled"

static

enabled

transient Boolean org.keycloak.storage.client.ClientStorageProviderModel.enabled

private

EVICTION_DAY

final String org.keycloak.storage.CacheableStorageProviderModel.EVICTION_DAY = "evictionDay"

staticinherited

EVICTION_HOUR

final String org.keycloak.storage.CacheableStorageProviderModel.EVICTION_HOUR = "evictionHour"

staticinherited

EVICTION_MINUTE

final String org.keycloak.storage.CacheableStorageProviderModel.EVICTION_MINUTE = "evictionMinute"

staticinherited

MAX_LIFESPAN

final String org.keycloak.storage.CacheableStorageProviderModel.MAX_LIFESPAN = "maxLifespan"

staticinherited

PRIORITY

final String org.keycloak.component.PrioritizedComponentModel.PRIORITY = "priority"

staticinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/client/ClientStorageProviderModel.java