class PlaceOS::Model::LdapAuthentication

Overview

see: https://github.com/omniauth/omniauth-ldap

Included Modules

Defined in:

placeos-models/ldap_authentication.cr

Constant Summary

CALLBACKS = {before_save: [] of Nil, after_save: [] of Nil, before_create: [do self.created_at = self.updated_at = Time.utc end] of Nil, after_create: [] of Nil, before_update: [do self.updated_at = Time.utc end] of Nil, after_update: [] of Nil, before_destroy: [] of Nil, after_destroy: [] of Nil}

see: https://github.com/omniauth/omniauth-ldap

Log = ::Log.for(self)

see: https://github.com/omniauth/omniauth-ldap

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class PlaceOS::Model::ModelBase

after_create after_create, after_destroy after_destroy, after_save after_save, after_update after_update, apply_defaults apply_defaults, assign_attributes(id : String | Nil | Missing = Missing)
assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
assign_attributes
, attributes attributes, attributes_tuple attributes_tuple, before_create before_create, before_destroy before_destroy, before_save before_save, before_update before_update, persistent_attributes persistent_attributes, run_create_callbacks(&) run_create_callbacks, run_destroy_callbacks(&) run_destroy_callbacks, run_save_callbacks(&) run_save_callbacks, run_update_callbacks(&) run_update_callbacks

Class methods inherited from class PlaceOS::Model::ModelBase

attributes : Array(Symbol) attributes

Constructor Detail

def self.from_trusted_json(string_or_io : String | IO) : self #

Serialize from a trusted JSON source


def self.from_trusted_yaml(string_or_io : String | IO) : self #

Serialize from a trusted YAML source


def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

see: https://github.com/omniauth/omniauth-ldap


def self.new(created_at : Time | Nil = nil, updated_at : Time | Nil = nil, name : String | Nil = nil, port : Int32 | Nil = nil, auth_method : String | Nil = nil, uid : String | Nil = nil, host : String | Nil = nil, base : String | Nil = nil, bind_dn : String | Nil | Nil = nil, password : String | Nil | Nil = nil, filter : String | Nil | Nil = nil, authority_id : String | Nil | Nil = nil, id : String | Nil | Nil = nil) #

see: https://github.com/omniauth/omniauth-ldap


def self.new(params : HTTP::Params | Hash(String, String) | Tuple(String, String)) #

Initialize PlaceOS::Model::LdapAuthentication from HTTP::Params.


Class Method Detail

def self.attributes : Array(Symbol) #

Returns all attribute keys.


def self.by_authority_id(id) #

Look up instances of this model dependent on the foreign key


[View source]
def self.elastic #

see: https://github.com/omniauth/omniauth-ldap


def self.table_name #

see: https://github.com/omniauth/omniauth-ldap


Instance Method Detail

def __authority : Authority | Nil #

def __authority=(__authority : Authority | Nil) #

def after_create #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def after_destroy #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def after_save #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def after_update #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def apply_defaults #

Generate code to apply default values


def assign_attributes(created_at : Time | Missing = Missing, updated_at : Time | Missing = Missing, name : String | Missing = Missing, port : Int32 | Missing = Missing, auth_method : String | Missing = Missing, uid : String | Missing = Missing, host : String | Missing = Missing, base : String | Missing = Missing, bind_dn : String | Nil | Missing = Missing, password : String | Nil | Missing = Missing, filter : String | Nil | Missing = Missing, authority_id : String | Nil | Missing = Missing, id : String | Nil | Missing = Missing) #

Assign to multiple attributes.


def assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String)) #

Assign to mulitple attributes via HTTP::Params.


def assign_attributes_from_json(json) #

see: https://github.com/omniauth/omniauth-ldap


def assign_attributes_from_trusted_json(json) #

see: https://github.com/omniauth/omniauth-ldap


def assign_attributes_from_trusted_yaml(yaml) #

see: https://github.com/omniauth/omniauth-ldap


def assign_attributes_from_yaml(yaml) #

Uses the YAML parser as JSON is valid YAML


def attributes #

Returns a Hash of all attribute values


def attributes_tuple #

Returns a NamedTuple of all attribute values.


def auth_method : String #

#auth_method getter


def auth_method=(value : String) #

#auth_method setter


def auth_method_change #

Returns { auth_method_was, auth_method } if #auth_method has changed.


def auth_method_changed? #

Check if #auth_method is in the set of changed attributes.


def auth_method_default : String #

#auth_method's default value


[View source]
def auth_method_was : String? #

Returns the previous value of #auth_method.


def auth_method_will_change! #

Include #auth_method in the set of changed attributes, whether it has changed or not.


def authority : Authority | Nil #

Retrieves the parent relationship


[View source]
def authority! : Authority #

[View source]
def authority=(parent : Authority) #

Sets the parent relationship


[View source]
def authority_id : String | Nil #

#authority_id getter


def authority_id=(value : String | Nil) #

#authority_id setter


def authority_id_change #

Returns { authority_id_was, authority_id } if #authority_id has changed.


def authority_id_changed? #

Check if #authority_id is in the set of changed attributes.


def authority_id_default : String | Nil #

#authority_id's default value


def authority_id_was : String? #

Returns the previous value of #authority_id.


def authority_id_will_change! #

Include #authority_id in the set of changed attributes, whether it has changed or not.


def base : String #

#base getter


def base=(value : String) #

#base setter


def base_change #

Returns { base_was, base } if #base has changed.


def base_changed? #

Check if #base is in the set of changed attributes.


def base_default : String #

#base's default value


[View source]
def base_was : String? #

Returns the previous value of #base.


def base_will_change! #

Include #base in the set of changed attributes, whether it has changed or not.


def before_create #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def before_destroy #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def before_save #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def before_update #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def bind_dn : String | Nil #

#bind_dn getter


def bind_dn=(value : String | Nil) #

#bind_dn setter


def bind_dn_change #

Returns { bind_dn_was, bind_dn } if #bind_dn has changed.


def bind_dn_changed? #

Check if #bind_dn is in the set of changed attributes.


def bind_dn_default : String | Nil #

#bind_dn's default value


[View source]
def bind_dn_was : String? #

Returns the previous value of #bind_dn.


def bind_dn_will_change! #

Include #bind_dn in the set of changed attributes, whether it has changed or not.


def changed? #

Check if any attributes have changed.


def changed_attributes #

Returns a Hash with all changed attributes.


def changed_json(io : IO) : Nil #

Serialize the set of changed attributes to JSON.


def changed_json : String #

Serialize the set of changed attributes to JSON.


def changed_yaml(io : IO) : Nil #

Serialize the set of changed attributes to YAML.


def changed_yaml : String #

Serialize the set of changed attributes to YAML.


def clear_changes_information #

Reset changes for all attributes.


def created_at : Time #

#created_at getter


def created_at=(value : Time) #

Override the map json #created_at setter


def created_at_change #

Returns { created_at_was, created_at } if #created_at has changed.


def created_at_changed? #

Check if #created_at is in the set of changed attributes.


def created_at_default : Time #

#created_at's default value


def created_at_was : Time? #

Returns the previous value of #created_at.


def created_at_will_change! #

Include #created_at in the set of changed attributes, whether it has changed or not.


def filter : String | Nil #

#filter getter


def filter=(value : String | Nil) #

#filter setter


def filter_change #

Returns { filter_was, filter } if #filter has changed.


def filter_changed? #

Check if #filter is in the set of changed attributes.


def filter_default : String | Nil #

#filter's default value


[View source]
def filter_was : String? #

Returns the previous value of #filter.


def filter_will_change! #

Include #filter in the set of changed attributes, whether it has changed or not.


def host : String #

#host getter


def host=(value : String) #

#host setter


def host_change #

Returns { host_was, host } if #host has changed.


def host_changed? #

Check if #host is in the set of changed attributes.


def host_default : String #

#host's default value


[View source]
def host_was : String? #

Returns the previous value of #host.


def host_will_change! #

Include #host in the set of changed attributes, whether it has changed or not.


def id : String | Nil #

#id getter


def id=(value : String | Nil) #

#id setter


def id_change #

Returns { id_was, id } if #id has changed.


def id_changed? #

Check if #id is in the set of changed attributes.


def id_was : String? #

Returns the previous value of #id.


def id_will_change! #

Include #id in the set of changed attributes, whether it has changed or not.


def name : String #

#name getter


def name=(value : String) #

#name setter


def name_change #

Returns { name_was, name } if #name has changed.


def name_changed? #

Check if #name is in the set of changed attributes.


def name_default : String #

#name's default value


[View source]
def name_was : String? #

Returns the previous value of #name.


def name_will_change! #

Include #name in the set of changed attributes, whether it has changed or not.


def password : String | Nil #

#password getter


def password=(value : String | Nil) #

#password setter


def password_change #

Returns { password_was, password } if #password has changed.


def password_changed? #

Check if #password is in the set of changed attributes.


def password_default : String | Nil #

#password's default value


[View source]
def password_was : String? #

Returns the previous value of #password.


def password_will_change! #

Include #password in the set of changed attributes, whether it has changed or not.


def persistent_attributes #

Returns a Hash of all attributes that can be persisted.


def port : Int32 #

#port getter


def port=(value : Int32) #

#port setter


def port_change #

Returns { port_was, port } if #port has changed.


def port_changed? #

Check if #port is in the set of changed attributes.


def port_default : Int32 #

#port's default value


[View source]
def port_was : Int32? #

Returns the previous value of #port.


def port_will_change! #

Include #port in the set of changed attributes, whether it has changed or not.


def reset_associations #

[View source]
def restore_attributes #

Reset each attribute to their previous values and clears all changes.


def run_create_callbacks(&) #

Wrap a block with callbacks for the appropriate crud operation


[View source]
def run_destroy_callbacks(&) #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def run_save_callbacks(&) #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def run_update_callbacks(&) #

see: https://github.com/omniauth/omniauth-ldap


[View source]
def table_name #

see: https://github.com/omniauth/omniauth-ldap


def to_json(json : JSON::Builder) #

see: https://github.com/omniauth/omniauth-ldap


def to_yaml(__temp_431 : YAML::Nodes::Builder) #

see: https://github.com/omniauth/omniauth-ldap


def uid : String #

#uid getter


def uid=(value : String) #

#uid setter


def uid_change #

Returns { uid_was, uid } if #uid has changed.


def uid_changed? #

Check if #uid is in the set of changed attributes.


def uid_default : String #

#uid's default value


[View source]
def uid_was : String? #

Returns the previous value of #uid.


def uid_will_change! #

Include #uid in the set of changed attributes, whether it has changed or not.


def updated_at : Time #

#updated_at getter


def updated_at=(value : Time) #

#updated_at setter


def updated_at_change #

Returns { updated_at_was, updated_at } if #updated_at has changed.


def updated_at_changed? #

Check if #updated_at is in the set of changed attributes.


def updated_at_default : Time #

#updated_at's default value


def updated_at_was : Time? #

Returns the previous value of #updated_at.


def updated_at_will_change! #

Include #updated_at in the set of changed attributes, whether it has changed or not.


def validate_nilability #

Validate that all non-nillable fields have values.