Module Core

$apply

• $apply($scope: )

• Performs a $scope.$apply() if not in a digest or apply phase on the given scope

  method

  $apply

  for

  Core

  static

  Parameters

  • $scope:

$applyLater

• $applyLater($scope: , timeout?: = 50)

• Performs a $scope.$apply() after the given timeout period

  method

  $applyLater

  for

  Core

  static

  Parameters

  • $scope:

  • timeout?: optional

$applyNowOrLater

• $applyNowOrLater($scope: )

• Performs a $scope.$apply() if not in a digest right now otherwise it will fire a digest later

  method

  $applyNowOrLater

  for

  Core

  static

  Parameters

  • $scope:

$digest

• $digest($scope: )

• Performs a $scope.$digest() if not in a digest or apply phase on the given scope

  method

  $apply

  for

  Core

  static

  Parameters

  • $scope:

_resetJolokiaUrls

• _resetJolokiaUrls()

• Private method to support testing.

  private

_resetUrlPrefix

• _resetUrlPrefix()

• Private method to support testing.

  private

addCSS

• addCSS(path: )

• Adds the specified CSS file to the document's head, handy for external plugins that might bring along their own CSS

  Parameters

  • path:

addRecentConnection

• addRecentConnection(localStorage: , name: )

• Parameters

  • localStorage:

  • name:

adjustHeight

• adjustHeight()

• Ensure our main app container takes up at least the viewport height

asArray

• asArray(value: )

• If the value is not an array then wrap it in one

  method

  asArray

  for

  Core

  static

  Parameters

  • value:

authHeaderValue

• authHeaderValue(userDetails: )

• Parameters

  • userDetails:

booleanToString

• booleanToString(value: )

• Converts boolean value to string "true" or "false"

  Parameters

  • value:

checkInjectorLoaded

• checkInjectorLoaded()

checkJolokiaOptimization

• checkJolokiaOptimization(jolokia: , jolokiaStatus: )

• Queries available server-side MBean to check if can call optimized jolokia.list() operation

  Parameters

  • jolokia:

  • jolokiaStatus:

clearConnections

• clearConnections()

clearNotifications

• clearNotifications()

• Clears all the pending notifications

  method

  clearNotifications

  static

compareVersionNumberArrays

• compareVersionNumberArrays(v1: , v2: )

• Compares the 2 version arrays and returns -1 if v1 is less than v2 or 0 if they are equal or 1 if v1 is greater than v2

  method

  compareVersionNumberArrays

  for

  Core

  static

  Parameters

  • v1:

    an array of version numbers with the most significant version first (major, minor, patch).

  • v2:

configuredPluginsForPerspectiveId

• configuredPluginsForPerspectiveId(perspectiveId: , workspace: , jolokia: , localStorage: )

• Function to return the configured plugin for the given perspective. The returned list is sorted in the configured order. Notice the list contains plugins which may have been configured as disabled.

  Parameters

  • perspectiveId:

  • workspace:

  • jolokia:

  • localStorage:

connectToServer

• connectToServer(localStorage: , options: )

• Parameters

  • localStorage:

  • options:

createConnectOptions

• createConnectOptions(options?: )

• Parameters

  • options?: optional

createConnectToServerOptions

• createConnectToServerOptions(options?: )

• Factory to create an instance of ConnectToServerOptions

  Parameters

  • options?: optional

createGraphStates

• createGraphStates(nodes: , links: , transitions: )

• Parameters

  • nodes:

  • links:

  • transitions:

createHref

• createHref($location: , href: , removeParams?: = null)

• Creates a link by appending the current $location.search() hash to the given href link, removing any required parameters from the link

  method

  createHref

  for

  Core

  static

  Parameters

  • $location:

  • href:

    the link to have any $location.search() hash parameters appended

  • removeParams?: optional

    any parameters to be removed from the $location.search()

createJolokia

• createJolokia(url: , username: , password: )

• Creates a jolokia object for connecting to the container with the given remote jolokia URL, username and password

  method

  createJolokia

  for

  Core

  static

  Parameters

  • url:

  • username:

  • password:

createRemoteWorkspace

• createRemoteWorkspace(remoteJolokia: , remoteJolokiaStatus: , $location: , localStorage: , $rootScope?: = null, $compile?: = null, $templateCache?: = null, userDetails?: = null)

• Creates a remote workspace given a remote jolokia for querying the JMX MBeans inside the jolokia

  Parameters

  • remoteJolokia:

  • remoteJolokiaStatus:

  • $location:

  • localStorage:

  • $rootScope?: optional

  • $compile?: optional

  • $templateCache?: optional

  • userDetails?: optional

createServerConnectionUrl

• createServerConnectionUrl(options: )

• Creates the Jolokia URL string for the given connection options

  Parameters

  • options:

d3ForceGraph

• d3ForceGraph(scope: , nodes: , links: , canvasElement: )

• Parameters

  • scope:

  • nodes:

  • links:

  • canvasElement:

dagreLayoutGraph

• dagreLayoutGraph(nodes: , links: , width: , height: , svgElement: , allowDrag?: = false, onClick?: = null)

• Parameters

  • nodes:

  • links:

  • width:

  • height:

  • svgElement:

  • allowDrag?: optional

  • onClick?: optional

dagreUpdateGraphData

• dagreUpdateGraphData(data: )

• Parameters

  • data:

defaultJolokiaErrorHandler

• defaultJolokiaErrorHandler(response: , options?: = {})

• The default error handler which logs errors either using debug or log level logging based on the silent setting

  Parameters

  • response:

    the response from a jolokia request

  • options?: optional

doNothing

• doNothing(value: )

• handy do nothing converter for the below function

  Parameters

  • value:

escapeHtml

• escapeHtml(str: )

• static escapeHtml method

  Parameters

  • str:

executePostLoginTasks

• executePostLoginTasks()

executePostLogoutTasks

• executePostLogoutTasks(onComplete: )

• Parameters

  • onComplete:

executePreLogoutTasks

• executePreLogoutTasks(onComplete: )

• Parameters

  • onComplete:

extractHashURL

• extractHashURL(url: )

• Parameters

  • url:

extractTargetUrl

• extractTargetUrl($location: , scheme: , port: )

• Extracts the url of the target, eg usually http://localhost:port, but if we use fabric to proxy to another host, then we return the url that we proxied too (eg the real target)

  Parameters

  • $location:

  • scheme:

    to force use a specific scheme, otherwise the scheme from location is used

  • port:

    to force use a specific port number, otherwise the port from location is used

fileExtension

• fileExtension(name: , defaultValue?: = "")

• Returns the lowercase file extension of the given file name or returns the empty string if the file does not have an extension

  method

  fileExtension

  for

  Core

  static

  Parameters

  • name:

  • defaultValue?: optional

filterTopLevelTabs

• filterTopLevelTabs(perspective: , workspace: , configuredPlugins: )

• Parameters

  • perspective:

  • workspace:

  • configuredPlugins:

forEachLeafFolder

• forEachLeafFolder(folders: , fn: )

• Invokes the given function on each leaf node in the array of folders

  method

  forEachLeafFolder

  for

  Core

  static

  Parameters

  • folders:

  • fn:

getBasicAuthHeader

• getBasicAuthHeader(username: , password: )

• Parameters

  • username:

  • password:

getConnectOptions

• getConnectOptions(name: , localStorage?: = Core.getLocalStorage())

• Returns the connection options for the given connection name from localStorage

  Parameters

  • name:

  • localStorage?: optional

getConnectionNameParameter

• getConnectionNameParameter(search: )

• Returns the current connection name using the given search parameters

  Parameters

  • search:

getDefaultPlugin

• getDefaultPlugin(perspectiveId: , workspace: , jolokia: , localStorage: )

• Gets the default configured plugin for the given perspective, or null if no default has been configured.

  Parameters

  • perspectiveId:

  • workspace:

  • jolokia:

  • localStorage:

getDocHeight

• getDocHeight()

getJolokiaUrl

• getJolokiaUrl()

• Returns Jolokia URL by checking its availability if not in local mode

getLocalStorage

• getLocalStorage()

• Wrapper to get the window local storage object

getMBeanTypeFolder

• getMBeanTypeFolder(workspace: , domain: , typeName: )

• Returns the Folder object for the given domain name and type name or null if it can not be found

  method

  getMBeanTypeFolder

  for

  Core

  static

  Parameters

  • workspace:

  • domain:

  • typeName:

getMBeanTypeObjectName

• getMBeanTypeObjectName(workspace: , domain: , typeName: )

• Returns the JMX objectName for the given jmx domain and type name

  method

  getMBeanTypeObjectName

  for

  Core

  static

  Parameters

  • workspace:

  • domain:

  • typeName:

getOrCreateElements

• getOrCreateElements(domElement: , arrayOfElementNames: )

• Look up a list of child element names or lazily create them.

  Useful for example to get the element from a

  lazily creating one if not present.

  Usage: var trElement = getOrCreateElements(tableElement, ["tbody", "tr"])

  method

  getOrCreateElements

  for

  Core

  static

  Parameters

  • domElement:

  • arrayOfElementNames:

  getOrInitObjectFromLocalStorage

  • getOrInitObjectFromLocalStorage(key: )

  • Parameters

    • key:

  getQueryParameterValue

  • getQueryParameterValue(url: , parameterName: )

  • Gets a query value from the given url

    Parameters

    • url:

      url

    • parameterName:

      the uri parameter value to get

  getRecentConnections

  • getRecentConnections(localStorage: )

  • Parameters

    • localStorage:

  getRegexs

  • getRegexs()

  getResponse

  • getResponse(jolokia: , arguments: , callback: )

  • Parameters

    • jolokia:

    • arguments:

    • callback:

  getResponseHistory

  • getResponseHistory()

  getUUID

  • getUUID()

  hashToString

  • hashToString(hash: )

  • Turns the given search hash into a URI style query string

    method

    hashToString

    for

    Core

    static

    Parameters

    • hash:

  humanizeMilliseconds

  • humanizeMilliseconds(value: )

  • Takes a value in ms and returns a human readable duration

    Parameters

    • value:

  humanizeValue

  • humanizeValue(value: )

  • Converts camel-case and dash-separated strings into Human readable forms

    Parameters

    • value:

  humanizeValueHtml

  • humanizeValueHtml(value: )

  • Returns the humanized markup of the given value

    Parameters

    • value:

  initPreferenceScope

  • initPreferenceScope($scope: , localStorage: , defaults: )

  • Parameters

    • $scope:

    • localStorage:

    • defaults:

  isBlank

  • isBlank(str: )

  • Returns true if the string is either null or empty

    method

    isBlank

    for

    Core

    static

    Parameters

    • str:

  isChromeApp

  • isChromeApp()

  isIgnorableException

  • isIgnorableException(response: )

  • Checks if it's an error that can happen on timing issues such as its been removed or if we run against older containers

    Parameters

    • response:

      the error response from a jolokia request

  isProxyUrl

  • isProxyUrl($location: )

  • Returns true if the $location is from the hawtio proxy

    Parameters

    • $location:

  isTextNode

  • isTextNode(node: )

  • Returns true if the given DOM node is a text node

    method

    isTextNode

    for

    Core

    static

    Parameters

    • node:

  isValidFunction

  • isValidFunction(workspace: , validFn: , perspectiveId: )

  • Returns true if there is no validFn defined or if its defined then the function returns true.

    method

    isValidFunction

    for

    Perspective

    Parameters

    • workspace:

    • validFn:

    • perspectiveId:

  keyForArgument

  • keyForArgument(argument: )

  • Parameters

    • argument:

  loadConnectionMap

  • loadConnectionMap()

  • Loads all of the available connections from local storage

  logJolokiaStackTrace

  • logJolokiaStackTrace(response: )

  • Logs any failed operation and stack traces

    Parameters

    • response:

  logout

  • logout(jolokiaUrl: , userDetails: , localStorage: , $scope: , successCB?: = null, errorCB?: = null)

  • log out the current user

    for

    Core

    static

    method

    logout

    Parameters

    • jolokiaUrl:

    • userDetails:

    • localStorage:

    • $scope:

    • successCB?: optional

    • errorCB?: optional

  maskPassword

  • maskPassword(value: )

  • Parameters

    • value:

  matchFilterIgnoreCase

  • matchFilterIgnoreCase(text: , filter: )

  • Match the given filter against the text, ignoring any case.

    This operation will regard as a match if either filter or text is null/undefined. As its used for filtering out, unmatched.

    Parameters

    • text:

      the text

    • filter:

      the filter

  maybePlural

  • maybePlural(count: , word: )

  • Given values (n, "person") will return either "1 person" or "2 people" depending on if a plural is required using the String.pluralize() function from sugarjs

    method

    maybePlural

    for

    Core

    static

    Parameters

    • count:

    • word:

  notification

  • notification(type: , message: , options?: = null)

  • Displays an alert message which is typically the result of some asynchronous operation

    method

    notification

    static

    Parameters

    • type:

      which is usually "success" or "error" and matches css alert-* css styles

    • message:

      the text to display

    • options?: optional

  numberToString

  • numberToString(value: )

  • Formats numbers as Strings.

    Parameters

    • value:

  objectNameProperties

  • objectNameProperties(objectName: )

  • given a JMX ObjectName of the form domain:key=value,another=something then return the object {key: "value", another: "something"}

    method

    objectNameProperties

    for

    Core

    static

    Parameters

    • objectName:

  operationToString

  • operationToString(name: , args: )

  • Parameters

    • name:

    • args:

  parseBooleanValue

  • parseBooleanValue(value: , defaultValue?: = false)

  • Ensure whatever value is passed in is converted to a boolean

    In the branding module for now as it's needed before bootstrap

    method

    parseBooleanValue

    for

    Core

    Parameters

    • value:

    • defaultValue?: optional

      default value to use if value is not defined

  parseFloatValue

  • parseFloatValue(value: , description?: = "float")

  • object to integer converter

    Parameters

    • value:

    • description?: optional

  parseIntValue

  • parseIntValue(value: , description?: = "integer")

  • object to integer converter

    Parameters

    • value:

    • description?: optional

  parseJsonText

  • parseJsonText(text: , message?: = "JSON")

  • Attempts to parse the given JSON text and returns the JSON object structure or null. Bad JSON is logged at info level.

    Parameters

    • text:

      a JSON formatted string

    • message?: optional

      description of the thing being parsed logged if its invalid

  parseMBean

  • parseMBean(mbean: )

  • Parameters

    • mbean:

  parsePreferencesJson

  • parsePreferencesJson(value: , key: )

  • Parsers the given value as JSON if it is define

    Parameters

    • value:

    • key:

  parseUrl

  • parseUrl(url: )

  • Breaks a URL up into a nice object

    method

    parseUrl

    for

    Core

    static

    Parameters

    • url:

  parseVersionNumbers

  • parseVersionNumbers(text: )

  • Parses some text of the form "xxxx2.3.4xxxx" to extract the version numbers as an array of numbers then returns an array of 2 or 3 numbers.

    Characters before the first digit are ignored as are characters after the last digit.

    method

    parseVersionNumbers

    for

    Core

    static

    Parameters

    • text:

      a maven like string containing a dash then numbers separated by dots

  pathGet

  • pathGet(object: , paths: )

  • Navigates the given set of paths in turn on the source object and returns the last most value of the path or null if it could not be found.

    method

    pathGet

    for

    Core

    static

    Parameters

    • object:

      the start object to start navigating from

    • paths:

      an array of path names to navigate or a string of dot separated paths to navigate

  pathSet

  • pathSet(object: , paths: , newValue: )

  • Navigates the given set of paths in turn on the source object and updates the last path value to the given newValue

    method

    pathSet

    for

    Core

    static

    Parameters

    • object:

      the start object to start navigating from

    • paths:

      an array of path names to navigate or a string of dot separated paths to navigate

    • newValue:

      the value to update

  putKeycloakToken

  • putKeycloakToken(newWindow: )

  • Parameters

    • newWindow:

  register

  • register(jolokia: , scope: , arguments: , callback: )

  • Register a JMX operation to poll for changes

    method

    register

    for

    Core

    static

    Parameters

    • jolokia:

    • scope:

    • arguments:

    • callback:

  registerForChanges

  • registerForChanges(jolokia: , $scope: , arguments: , callback: , options?: )

  • Register a JMX operation to poll for changes, only calls back when a change occurs

    Parameters

    • jolokia:

    • $scope:

    • arguments:

    • callback:

    • options?: optional

  removeRecentConnection

  • removeRecentConnection(localStorage: , name: )

  • Parameters

    • localStorage:

    • name:

  removeRegex

  • removeRegex(name: )

  • Parameters

    • name:

  safeTabsToPlugins

  • safeTabsToPlugins(tabs: )

  • Function which safely can turn tabs/plugins to plugins

    Parameters

    • tabs:

  saveConnection

  • saveConnection(options: )

  • Parameters

    • options:

  saveConnectionMap

  • saveConnectionMap(map: )

  • Saves the connection map to local storage

    Parameters

    • map:

  setPageTitle

  • setPageTitle($document: , title: )

  • Parameters

    • $document:

    • title:

  setPageTitleWithTab

  • setPageTitleWithTab($document: , title: , tab: )

  • Parameters

    • $document:

    • title:

    • tab:

  storeConnectionRegex

  • storeConnectionRegex(regexs: , name: , json: )

  • Parameters

    • regexs:

    • name:

    • json:

  stringToHash

  • stringToHash(hashAsString: )

  • Parses the given string of x=y&bar=foo into a hash

    method

    stringToHash

    for

    Core

    static

    Parameters

    • hashAsString:

  throttled

  • throttled(fn: , millis: )

  • Returns a new function which ensures that the delegate function is only invoked at most once within the given number of millseconds

    method

    throttled

    for

    Core

    static

    Parameters

    • fn:

      the function to be invoked at most once within the given number of millis

    • millis:

      the time window during which this function should only be called at most once

  time

  • time(message: , fn: )

  • Parameters

    • message:

    • fn:

  toPath

  • toPath(hashUrl: )

  • Parameters

    • hashUrl:

  toSafeDomID

  • toSafeDomID(text: )

  • Removes dodgy characters from a value such as '/' or '.' so that it can be used as a DOM ID value and used in jQuery / CSS selectors

    method

    toSafeDomID

    for

    Core

    static

    Parameters

    • text:

  toString

  • toString(value: )

  • Parameters

    • value:

  trimLeading

  • trimLeading(text: , prefix: )

  • Trims the leading prefix from a string if its present

    method

    trimLeading

    for

    Core

    static

    Parameters

    • text:

    • prefix:

  trimQuotes

  • trimQuotes(text: )

  • removes all quotes/apostrophes from beginning and end of string

    Parameters

    • text:

  trimTrailing

  • trimTrailing(text: , postfix: )

  • Trims the trailing postfix from a string if its present

    method

    trimTrailing

    for

    Core

    static

    Parameters

    • text:

    • postfix:

  tryParseJson

  • tryParseJson(text: )

  • If the string starts and ends with [] {} then try parse as JSON and return the parsed content or return null if it does not appear to be JSON

    method

    tryParseJson

    for

    Core

    static

    Parameters

    • text:

  unescapeHtml

  • unescapeHtml(str: )

  • static unescapeHtml

    Parameters

    • str:

  unregister

  • unregister(jolokia: , scope: )

  • Register a JMX operation to poll for changes using a jolokia search using the given mbean pattern

    method

    registerSearch

    for

    Core

    static

    paran

    {*} jolokia

    Parameters

    • jolokia:

    • scope:

  url

  • url(path: )

  • Prefixes absolute URLs with current window.location.pathname

    Parameters

    • path:

  useProxyIfExternal

  • useProxyIfExternal(connectUrl: )

  • If a URL is external to the current web application, then replace the URL with the proxy servlet URL

    method

    useProxyIfExternal

    for

    Core

    static

    Parameters

    • connectUrl:

  valueToHtml

  • valueToHtml(value: )

  • Helper function which converts objects into tables of key/value properties and lists into a

    for each value.

    method

    valueToHtml

    for

    Core

    static

    Parameters

    • value:

  versionToSortableString

  • versionToSortableString(version: , maxDigitsBetweenDots?: = 4)

  • Converts a version string with numbers and dots of the form "123.456.790" into a string which is sortable as a string, by left padding each string between the dots to at least 4 characters so things just sort as a string.

    Parameters

    • version:

    • maxDigitsBetweenDots?: optional

  windowLocation

  • windowLocation()

  • Returns location of the global window

  writeRegexs

  • writeRegexs(regexs: )

  • Parameters

    • regexs:

  xmlNodeToString

  • xmlNodeToString(xmlNode: )

  • Converts the given XML node to a string representation of the XML

    method

    xmlNodeToString

    for

    Core

    static

    Parameters

    • xmlNode:

  Variables

  AppController

  AppController:

  Outermost controller attached to almost the root of the document, handles logging in and logging out, the PID/container indicator at the bottom right of the window and the document title

  method

  AppController

  for

  Core

  static

  param

  param

  param

  param

  param

  param

  param

  param

  param

  param

  param

  ConnectionName

  ConnectionName:

  ConsoleController

  ConsoleController:

  Controller that's attached to hawtio's drop-down console, mainly handles the clipboard icon at the bottom-right of the console.

  method

  ConsoleController

  for

  Core

  static

  param

  param

  param

  DEFAULT_MAX_COLLECTION_SIZE

  DEFAULT_MAX_COLLECTION_SIZE:

  DEFAULT_MAX_DEPTH

  DEFAULT_MAX_DEPTH:

  LIST_CANT_DETERMINE

  LIST_CANT_DETERMINE:

  LIST_GENERAL

  LIST_GENERAL:

  LIST_WITH_RBAC

  LIST_WITH_RBAC:

  MAX_RESPONSE_CACHE_SIZE

  MAX_RESPONSE_CACHE_SIZE:

  NavBarController

  NavBarController:

  PluginPreferences

  PluginPreferences:

  ViewController

  ViewController:

  _escapeHtmlChars

  _escapeHtmlChars:

  _module

  _module:

  The main hawtio core App module

  _urlPrefix

  _urlPrefix:

  _versionRegex

  _versionRegex:

  bindModelToSearchParam

  bindModelToSearchParam:

  checkKeycloakEnabled

  checkKeycloakEnabled:

  chrome

  chrome:

  connectionSettingsKey

  connectionSettingsKey:

  createKeycloakContext

  createKeycloakContext:

  Create keycloak context instance and push it to angular

  dummyStorage

  dummyStorage:

  fileUploadMBean

  fileUploadMBean:

  httpRegex

  httpRegex:

  initKeycloakIfNeeded

  initKeycloakIfNeeded:

  injector

  injector:

  The instance of this app's Angular injector, set once bootstrap has completed, helper functions can use this to grab angular services so they don't need them as arguments

  type

  {null}

  jolokiaUrl

  jolokiaUrl:

  URL we've detected to find jolokia at we figure this out at script loading time

  jolokiaUrls

  jolokiaUrls:

  keycloakJaasSetup

  keycloakJaasSetup:

  lazyLoaders

  lazyLoaders:

  loadKeycloakAdapter

  loadKeycloakAdapter:

  log

  log:

  loginController

  loginController:

  pluginName

  pluginName:

  Name of plugin registered to hawtio's plugin loader and Angularjs module name

  property

  pluginName

  for

  Core

  type

  String

  postLoginTasks

  postLoginTasks:

  postLogoutTasks

  postLogoutTasks:

  preLogoutTasks

  preLogoutTasks:

  reloadWhenParametersChange

  reloadWhenParametersChange:

  responseHistory

  responseHistory:

  templatePath

  templatePath:

  Path to template files for this plugin

  property

  pluginName

  for

  Core

  type

  String

  validateSubjectMatches

  validateSubjectMatches:

  Validate if subject authenticated through Keycloak matches with SSO

  Generated using TypeDoc