config.io_helidon_security_SecurityTime.adoc Maven / Gradle / Ivy

Go to download
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2023 Oracle and/or its affiliates.

    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.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.security.SecurityTime
:keywords: helidon, config, io.helidon.security.SecurityTime
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.security.SecurityTime
include::{rootdir}/includes/attributes.adoc[]

= SecurityTime (security) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.security/io/helidon/security/SecurityTime.html[io.helidon.security.SecurityTime]




== Configuration options



.Optional configuration options
[cols="3,3a,2,5a"]

|===
|key |type |default value |description

|`day-of-month` |long |{nbsp} |Set an explicit value for one of the time fields (such as ChronoField#YEAR).
|`hour-of-day` |long |{nbsp} |Set an explicit value for one of the time fields (such as ChronoField#YEAR).
|`millisecond` |long |{nbsp} |Set an explicit value for one of the time fields (such as ChronoField#YEAR).
|`minute` |long |{nbsp} |Set an explicit value for one of the time fields (such as ChronoField#YEAR).
|`month` |long |{nbsp} |Set an explicit value for one of the time fields (such as ChronoField#YEAR).
|`second` |long |{nbsp} |Set an explicit value for one of the time fields (such as ChronoField#YEAR).
|`shift-by-seconds` |long |`0` |Configure a time-shift in seconds, to move the current time to past or future.
|`time-zone` |ZoneId |{nbsp} |Override current time zone. The time will represent the SAME instant, in an explicit timezone.

 If we are in a UTC time zone and you set the timezone to "Europe/Prague", the time will be shifted by the offset
 of Prague (e.g. if it is noon right now in UTC, you would get 14:00).
|`year` |long |{nbsp} |Set an explicit value for one of the time fields (such as ChronoField#YEAR).

|===

// end::config[]