Package org.apache.camel.component.servicenow

Class ServiceNowConfiguration

  • All Implemented Interfaces:
    Cloneable
    @UriParams
public class ServiceNowConfiguration
extends Object
implements Cloneable

    • Constructor Detail

      • ServiceNowConfiguration

        public ServiceNowConfiguration()

    • Method Detail

      • getUserName

        public String getUserName()

      • getApiUrl

        public String getApiUrl()

      • setApiUrl

        public void setApiUrl​(String apiUrl)
        The ServiceNow REST API url

      • hasApiUrl

        public boolean hasApiUrl()

      • getApiVersion

        public String getApiVersion()

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        The ServiceNow REST API version, default latest

      • setUserName

        public void setUserName​(String userName)
        ServiceNow user account name, MUST be provided

      • getPassword

        public String getPassword()

      • setPassword

        public void setPassword​(String password)
        ServiceNow account password, MUST be provided

      • getOauthClientId

        public String getOauthClientId()

      • setOauthClientId

        public void setOauthClientId​(String oauthClientId)
        OAuth2 ClientID

      • getOauthClientSecret

        public String getOauthClientSecret()

      • setOauthClientSecret

        public void setOauthClientSecret​(String oauthClientSecret)
        OAuth2 ClientSecret

      • getOauthTokenUrl

        public String getOauthTokenUrl()

      • hasOauthTokenUrl

        public boolean hasOauthTokenUrl()

      • setOauthTokenUrl

        public void setOauthTokenUrl​(String oauthTokenUrl)
        OAuth token Url

      • hasBasicAuthentication

        public boolean hasBasicAuthentication()

      • hasOAuthAuthentication

        public boolean hasOAuthAuthentication()

      • getResource

        public String getResource()

      • setResource

        public void setResource​(String resource)
        The default resource, can be overridden by header CamelServiceNowResource

      • getTable

        public String getTable()

      • setTable

        public void setTable​(String table)
        The default table, can be overridden by header CamelServiceNowTable

      • getExcludeReferenceLink

        public Boolean getExcludeReferenceLink()

      • setExcludeReferenceLink

        public void setExcludeReferenceLink​(Boolean excludeReferenceLink)
        True to exclude Table API links for reference fields (default: false)

      • getSuppressAutoSysField

        public Boolean getSuppressAutoSysField()

      • setSuppressAutoSysField

        public void setSuppressAutoSysField​(Boolean suppressAutoSysField)
        True to suppress auto generation of system fields (default: false)

      • getSuppressPaginationHeader

        public Boolean getSuppressPaginationHeader()

      • setSuppressPaginationHeader

        public void setSuppressPaginationHeader​(Boolean suppressPaginationHeader)
        Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit

      • getIncludeScores

        public Boolean getIncludeScores()

      • setIncludeScores

        public void setIncludeScores​(Boolean includeScores)
        Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value.

      • getIncludeAggregates

        public Boolean getIncludeAggregates()

      • setIncludeAggregates

        public void setIncludeAggregates​(Boolean includeAggregates)
        Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.

      • getIncludeAvailableBreakdowns

        public Boolean getIncludeAvailableBreakdowns()

      • setIncludeAvailableBreakdowns

        public void setIncludeAvailableBreakdowns​(Boolean includeAvailableBreakdowns)
        Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns.

      • getIncludeAvailableAggregates

        public Boolean getIncludeAvailableAggregates()

      • setIncludeAvailableAggregates

        public void setIncludeAvailableAggregates​(Boolean includeAvailableAggregates)
        Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.

      • getIncludeScoreNotes

        public Boolean getIncludeScoreNotes()

      • setIncludeScoreNotes

        public void setIncludeScoreNotes​(Boolean includeScoreNotes)
        Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added.

      • getFavorites

        public Boolean getFavorites()

      • setFavorites

        public void setFavorites​(Boolean favorites)
        Set this parameter to true to return only scorecards that are favorites of the querying user.

      • getRetrieveTargetRecordOnImport

        public Boolean getRetrieveTargetRecordOnImport()

      • setRetrieveTargetRecordOnImport

        public void setRetrieveTargetRecordOnImport​(Boolean retrieveTargetRecordOnImport)
        Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record

      • setKey

        public void setKey​(Boolean key)
        Set this parameter to true to return only scorecards for key indicators.

      • getTarget

        public Boolean getTarget()

      • setTarget

        public void setTarget​(Boolean target)
        Set this parameter to true to return only scorecards that have a target.

      • getDisplay

        public String getDisplay()

      • setDisplay

        public void setDisplay​(String display)
        Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default.

      • getPerPage

        public Integer getPerPage()

      • setPerPage

        public void setPerPage​(Integer perPage)
        Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.

      • getSortBy

        public String getSortBy()

      • setSortBy

        public void setSortBy​(String sortBy)
        Specify the value to use when sorting results. By default, queries sort records by value.

      • getSortDir

        public String getSortDir()

      • setSortDir

        public void setSortDir​(String sortDir)
        Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order.

      • getDisplayValue

        public String getDisplayValue()

      • setDisplayValue

        public void setDisplayValue​(String displayValue)
        Return the display value (true), actual value (false), or both (all) for reference fields (default: false)

      • getInputDisplayValue

        public Boolean getInputDisplayValue()

      • setInputDisplayValue

        public void setInputDisplayValue​(Boolean inputDisplayValue)
        True to set raw value of input fields (default: false)

      • getRequestModels

        public Map<String,​Class<?>> getRequestModels()

      • setMapper

        public void setMapper​(com.fasterxml.jackson.databind.ObjectMapper mapper)
        Sets Jackson's ObjectMapper to use for request/reply

      • getMapper

        public com.fasterxml.jackson.databind.ObjectMapper getMapper()

      • getOrCreateMapper

        public com.fasterxml.jackson.databind.ObjectMapper getOrCreateMapper()

      • hasMapper

        public boolean hasMapper()

      • setRelease

        public void setRelease​(ServiceNowRelease release)
        The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com

      • getTopLevelOnly

        public Boolean getTopLevelOnly()

      • setTopLevelOnly

        public void setTopLevelOnly​(Boolean topLevelOnly)
        Gets only those categories whose parent is a catalog.

      • getSslContextParameters

        public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()

      • setSslContextParameters

        public void setSslContextParameters​(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
        To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html

      • getHttpClientPolicy

        public org.apache.cxf.transports.http.configuration.HTTPClientPolicy getHttpClientPolicy()

      • setHttpClientPolicy

        public void setHttpClientPolicy​(org.apache.cxf.transports.http.configuration.HTTPClientPolicy httpClientPolicy)
        To configure http-client

      • getProxyAuthorizationPolicy

        public org.apache.cxf.configuration.security.ProxyAuthorizationPolicy getProxyAuthorizationPolicy()

      • setProxyAuthorizationPolicy

        public void setProxyAuthorizationPolicy​(org.apache.cxf.configuration.security.ProxyAuthorizationPolicy proxyAuthorizationPolicy)
        To configure proxy authentication

      • getProxyHost

        public String getProxyHost()

      • setProxyHost

        public void setProxyHost​(String proxyHost)
        The proxy host name

      • getProxyPort

        public Integer getProxyPort()

      • setProxyPort

        public void setProxyPort​(Integer proxyPort)
        The proxy port number

      • getProxyUserName

        public String getProxyUserName()

      • setProxyUserName

        public void setProxyUserName​(String proxyUserName)
        Username for proxy authentication

      • getProxyPassword

        public String getProxyPassword()

      • setProxyPassword

        public void setProxyPassword​(String proxyPassword)
        Password for proxy authentication

      • getDateFormat

        public String getDateFormat()

      • setDateFormat

        public void setDateFormat​(String dateFormat)
        The date format used for Json serialization/deserialization

      • getTimeFormat

        public String getTimeFormat()

      • setTimeFormat

        public void setTimeFormat​(String timeFormat)
        The time format used for Json serialization/deserialization

      • getDateTimeFormat

        public String getDateTimeFormat()

      • setDateTimeFormat

        public void setDateTimeFormat​(String dateTimeFormat)
        The date-time format used for Json serialization/deserialization

      • setModels

        public void setModels​(Map<String,​Class<?>> models)

      • addModel

        public void addModel​(String name,
                     Class<?> type)

      • setRequestModels

        public void setRequestModels​(Map<String,​Class<?>> models)
        Defines the request model

      • getResponseModels

        public Map<String,​Class<?>> getResponseModels()

      • addRequestModel

        public void addRequestModel​(String name,
                            Class<?> type)

      • getRequestModel

        public Class<?> getRequestModel​(String name)

      • getRequestModel

        public Class<?> getRequestModel​(String name,
                                Class<?> defaultType)

      • setResponseModels

        public void setResponseModels​(Map<String,​Class<?>> models)
        Defines the response model

      • addResponseModel

        public void addResponseModel​(String name,
                             Class<?> type)

      • getResponseModel

        public Class<?> getResponseModel​(String name)

      • getResponseModel

        public Class<?> getResponseModel​(String name,
                                 Class<?> defaultType)