Module: Keycloak

Defined in:
lib/keycloak.rb,
lib/keycloak/version.rb,
lib/keycloak/exceptions.rb

Defined Under Namespace

Modules: Admin, Client, Internal Classes: InstallationFileNotFound, KeycloakException, ProcCookieTokenNotDefined, ProcExternalAttributesNotDefined, UserLoginNotFound

Constant Summary collapse

OLD_KEYCLOAK_JSON_FILE = 
'keycloak.json'
KEYCLOAK_JSON_FILE = 
'config/keycloak.json'
VERSION = 
"2.4.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.auth_server_url ⇒ Object

Returns the value of attribute auth_server_url.



13
14
15
 
# File 'lib/keycloak.rb', line 13

def auth_server_url
  @auth_server_url
end

.generate_request_exception ⇒ Object

Returns the value of attribute generate_request_exception.



13
14
15
 
# File 'lib/keycloak.rb', line 13

def generate_request_exception
  @generate_request_exception
end

.keycloak_controller ⇒ Object

Returns the value of attribute keycloak_controller.



13
14
15
 
# File 'lib/keycloak.rb', line 13

def keycloak_controller
  @keycloak_controller
end

.proc_cookie_token ⇒ Object

Returns the value of attribute proc_cookie_token.



13
14
15
 
# File 'lib/keycloak.rb', line 13

def proc_cookie_token
  @proc_cookie_token
end

.proc_external_attributes ⇒ Object

Returns the value of attribute proc_external_attributes.



13
14
15
 
# File 'lib/keycloak.rb', line 13

def proc_external_attributes
  @proc_external_attributes
end

.proxy ⇒ Object

Returns the value of attribute proxy.



13
14
15
 
# File 'lib/keycloak.rb', line 13

def proxy
  @proxy
end

.realm ⇒ Object

Returns the value of attribute realm.



13
14
15
 
# File 'lib/keycloak.rb', line 13

def realm
  @realm
end

Class Method Details

.explode_exception ⇒ Object 



18
19
20
21
 
# File 'lib/keycloak.rb', line 18

def self.explode_exception
  Keycloak.generate_request_exception = true if Keycloak.generate_request_exception.nil?
  Keycloak.generate_request_exception
end

.installation_file ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/keycloak.rb', line 23

def self.installation_file
  if File.exists?(KEYCLOAK_JSON_FILE)
    @installation_file ||= KEYCLOAK_JSON_FILE
  else
    @installation_file ||= OLD_KEYCLOAK_JSON_FILE
  end
end

.installation_file=(file = nil) ⇒ Object

Raises:



31
32
33
34
 
# File 'lib/keycloak.rb', line 31

def self.installation_file=(file = nil)
  raise InstallationFileNotFound unless file.instance_of?(String) && File.exists?(file)
  @installation_file = file || KEYCLOAK_JSON_FILE
end