args

Documentation

Index

• type Logging
  • func (arg *Logging) Flags() []cli.Flag
  • func (arg *Logging) Logger() *zerolog.Logger
• type MemoryDB
  • func (arg *MemoryDB) Flags() []cli.Flag
• type MongoDB
  • func (arg *MongoDB) Connect(ctx context.Context) (client *mongo.Client, err error)
  • func (arg *MongoDB) Flags() []cli.Flag
  • func (arg *MongoDB) RegisterMetadata() error
  • func (arg *MongoDB) Url() string
• type RabbitMQ
  • func (arg *RabbitMQ) Connect(ctx context.Context) (*amqp.Connection, error)
  • func (arg *RabbitMQ) Flags() []cli.Flag
  • func (arg *RabbitMQ) Url() string
• type Scim
  • func (arg *Scim) Flags() []cli.Flag
  • func (arg *Scim) ParseGroupResourceType() (*spec.ResourceType, error)
  • func (arg *Scim) ParseServiceProviderConfig() (*spec.ServiceProviderConfig, error)
  • func (arg *Scim) ParseUserResourceType() (*spec.ResourceType, error)
  • func (arg *Scim) RegisterSchemas() error

Types

type Logging

type Logging struct {
	Level string
}

Logging is the configuration options related to logging

func (*Logging) Flags

func (arg *Logging) Flags() []cli.Flag

func (*Logging) Logger

func (arg *Logging) Logger() *zerolog.Logger

type MemoryDB

type MemoryDB struct {
	UseMemoryDB bool
}

MemoryDB is the configuration options related to a in-memory db.DB implementation.

func (*MemoryDB) Flags

func (arg *MemoryDB) Flags() []cli.Flag

type MongoDB

type MongoDB struct {
	Host        string
	Port        int
	Username    string
	Password    string
	Database    string
	Options     string
	MetadataDir string
}

MongoDB is the configuration options related to using the MongoDB implementation of db.DB

func (*MongoDB) Connect

func (arg *MongoDB) Connect(ctx context.Context) (client *mongo.Client, err error)

Connect returns a connected MongoDB client using the set options, or an error.

func (*MongoDB) Flags

func (arg *MongoDB) Flags() []cli.Flag

func (*MongoDB) RegisterMetadata

func (arg *MongoDB) RegisterMetadata() error

RegisterMetadata iterates all JSON files in the MetadataDir and registers its content as SCIM MongoDB metadata.

func (*MongoDB) Url

func (arg *MongoDB) Url() string

Url returns the MongoDB connection URL created using the set options.

type RabbitMQ

type RabbitMQ struct {
	Username string
	Password string
	Host     string
	Port     int
	VHost    string
	Options  string
}

RabbitMQ is the options related to connecting to RabbitMQ message middleware

func (*RabbitMQ) Connect

func (arg *RabbitMQ) Connect(ctx context.Context) (*amqp.Connection, error)

Connect returns a connected RabbitMQ AMQP connection using the options set, or an error. This method respects the provided context, and makes the connection process cancellable and timeout-able. The default RabbitMQ connection timeouts were kept in place, with the default timeout of 30 seconds.

func (*RabbitMQ) Flags

func (arg *RabbitMQ) Flags() []cli.Flag

func (*RabbitMQ) Url

func (arg *RabbitMQ) Url() string

Url returns the RabbitMQ connection url from the options set.

type Scim

type Scim struct {
	// Path to the service provider config JSON file
	ServiceProviderConfigPath string
	// Path to the user resource type JSON file
	UserResourceTypePath string
	// Path to the group resource type JSON file
	GroupResourceTypePath string
	// Path to the directory containing all schema JSON file
	SchemasDirectory string
}

Scim the configuration options related to the core SCIM specification.

func (*Scim) Flags

func (arg *Scim) Flags() []cli.Flag

func (*Scim) ParseGroupResourceType

func (arg *Scim) ParseGroupResourceType() (*spec.ResourceType, error)

ParseGroupResourceType returns the parsed spec.ResourceType from the JSON schema definition at GroupResourceTypePath Caller must make sure RegisterSchemas was invoked first.

func (*Scim) ParseServiceProviderConfig

func (arg *Scim) ParseServiceProviderConfig() (*spec.ServiceProviderConfig, error)

ParseServiceProviderConfig returns an instance of spec.ServiceProviderConfig from the JSON definition at ServiceProviderConfigPath, or an error.

func (*Scim) ParseUserResourceType

func (arg *Scim) ParseUserResourceType() (*spec.ResourceType, error)

ParseUserResourceType returns the parsed spec.ResourceType from the JSON schema definition at UserResourceTypePath. Caller must make sure RegisterSchemas was invoked first.

func (*Scim) RegisterSchemas

func (arg *Scim) RegisterSchemas() error

RegisterSchemas iterates through all JSON files in the SchemasDirectory directory and registers all of them as schema files.