| Back | Main view

IMiS/Storage Connector SOAP Service configuration file

Product:IMiS/Storage Connector SOAP Service
Release:IMiS/Storage Connector SOAP Service configuration file
Date:04/12/2021

Case: This article describes the IMiS/Storage Connector SOAP Service configuration file (config.xml) in detail.

Description:


Hierarchical IndexAlphabetical Index
<services>
  <config>
    <storage>
      <proxy/>
      <address/>
      <authentication/>
      <profile/>
      <operation/>
      <auditlog/>
    </storage>
    <security>
      <group>
        <user/>
        <address/>
      </group>
      <acl>
        <allow>
          <group/>
          <user/>
          <address/>
        </allow>
        <deny>
          <group/>
          <user/>
          <address/>
        </deny>
      </acl>
    </security>
    <logging/>
  </config>
</services>
<acl>
<address>
<allow>
<auditlog>
<authentication>
<config>
<deny>
<group>
<logging>
<operation>
<profile>
<proxy>
<security>
<services>
<storage>
<user>

<services>

The <services> element is the root element of the IMiS/Storage Connector SOAP Service configuration file (config.xml) and contains a required <config> element.

Child elements:

ElementCardinalityDescription
<config>1A placeholder for the <logging>, <storage> and <security> elements.

<config>

The <config> element is the root element of the configuration, and acts as a container to the rest of the configuration elements. The <config> element is a required element.

Attributes:

AttributeRequiredDescription
includeextdelimiteryesIf "true", file extension delimiter is returned in service "getobject" responses. Valid values: "true" or "false" (case insensitive). By default file extension delimiter is not returned. Requires IMiS/Storage Connector SOAP Service version 3.3.2005.

Child elements:

ElementCardinalityDescription
<storage>1..*Container element for the <proxy>, <address>, <profile>, <operation>, <authentication> and <auditlog> elements. Element <proxy> is available since IMiS/Storage Connector SOAP Service version 3.4.2103.
<security>0..1Container element for the <group> and <acl> elements.
<logging>0..1Used to enable IMiS/Storage Connector SOAP Service logging and to set the logging level.

<storage>

The <storage> element is used to define a storage used by IMiS/Storage Connector SOAP Service requests. Storage is defined through attributes such as storage identifier and type, ACL configuration and object identifier options, and child elements address, profile, authentication, audit log and operation elements. At least one <storage> element must be specified for configuration to be valid.

Attributes:

AttributeRequiredDescription
nameyesThe storage identifier. Value must be a non-empty string (case insensitive).
typeyesThe storage type. Currently the only supported storage is IMiS/ARC Storage Server. Valid values are: "imisarc" or "proxy" (case insensitive). Storage type "proxy" is available since IMiS/Storage Connector SOAP Service version 3.4.2103.
defaultno (defaults to "false")If "true", this storage is default storage for service requests that do not specify a storage identifier. Valid values are "true" or "false" (case insensitive). This attribute is used only with storage type "imisarc".
aclnoThe ACL configuration to use. Valid value is an existing <acl> element identifier (case sensitive). This attribute is used only with storage type "imisarc".
idtypenoThe object identifier type. Valid values are "id192" or "id256" (case insensitive). By default object identifier type is set to "id256". This attribute is used only with storage type "imisarc".
idencodingnoThe object identifier encoding. Valid values are "base16", "base64" or "base85" (case insensitive). By default object identifier encoding is set to "base16". This attribute is used only with storage type "imisarc".
idkindnoThe object identifier kind. Valid values are "internal" or "external" (case insensitive). By default object identifier kind is set to "internal". This attribute is used only with storage type "imisarc".
sessionsperusernoThe maximum number of sessions per user (i.e. number of sessions in context session pool). By default the maximum number of sessions per user is set to 4. Valid values are numbers equal or greater than 1. This attribute is used only with storage type "imisarc". Requires IMiS/Storage Connector SOAP Service version 3.3.1910.
persistentsessionsnoIf "true", established sessions should be preserved for subsequent usage, else they should be closed after each transaction. By default established sessions are persistent. Valid values are "true" or "false" (case insensitive). This attribute is used only with storage type "imisarc". Requires IMiS/Storage Connector SOAP Service version 3.3.1910.

Child elements:

ElementCardinalityDescription
<proxy>0..1The storage proxy. This element is required when storage type equals "proxy". This element is used only with storage type "proxy". Available since IMiS/Storage Connector SOAP Service version 3.4.2103.
<address>0..*The storage address. At least one <address> element is required. Two or more <address> elements represent IMiS/ARC Storage Servers in a cluster.
<authentication>0..1Configures the authentication used when establishing a connection with IMiS/ARC Storage Server.
<profile>0..*The storage profile. The <profile> element is required when "storeObject" service request is used.
<operation>0..2Used to set the ACL configuration for a specific service request. Currently the only operations are "getObject" and "storeObject".
<auditlog>0..1Configures what audit log parameters are being logged with IMiS/Storage Connector.

<security>

The <security> element is used to define groups of users and addresses, and ACLs.

Child elements:

ElementCardinalityDescription
<group>0..*Defines a security group. Container element for <user> and <address> elements.
<acl>0..*Defines a security ACL. Container element for <allow> and <deny> elements.

<logging>

The <logging> element is used to enable internal logging and set the logging level of the IMiS/Storage Connector used by this service.

Attributes:

AttributeRequiredDescription
enableno (defaults to "false")If "true", IMiS/Storage Connector internal logging used by this service is enabled. Valid values: "true" or "false" (case insensitive).
levelno (defaults to "off")The logging level. Valid values are "severe", "warning", "info", "config", "fine", "finer", "finest", "all" and "off" (case insensitive).

<acl>

The <acl> element is used to define an access control list (ACL). ACL specifies which users from which addresses are authorized to access objects on storages and profiles, as well as what operations are allowed on given objects.

Attributes:

AttributeRequiredDescription
idyesUnique ACL identifier. Value must be a non-empty string.
defaultno (defaults to "deny" if <allow> child element exists; otherwise defaults to "allow")The default ACL disposition. If "allow", service requests from users or addresses not specified in <deny> element are authorized; otherwise service requests from users or addresses specified in <allow> element are authorized. Valid values: "allow" or "deny" (case insensitive).

Child elements:

ElementCardinalityDescription
<allow>0..1Container element for <group>, <user> and <address> elements.
<deny>0..1Container element for <group>, <user> and <address> elements.

<allow>

The <allow> element is a placeholder for the <group>, <user> and <address> elements.

Child elements:

ElementCardinalityDescription
<group>0..*A group of users and addresses that are authorized for service requests.
<user>0..*A user that is authorized for service requests.
<address>0..*An address that is authorized for service requests.

<deny>

The <deny> element is a placeholder for the <group>, <user> and <address> elements.

Child elements:

ElementCardinalityDescription
<group>0..*A group of users and addresses that are not authorized for service requests.
<user>0..*A user that is not authorized for service requests.
<address>0..*An address that is not authorized for service requests.

<group>

The <group> element represents group of users and addresses in an ACL-based security model. The <group> element is a placeholder for the <user> and <address> elements.

Attributes:

AttributeRequiredDescription
idyesUnique group identifier. Value must be a non-empty string.

Child elements:

ElementCardinalityDescription
<user>0..*A user belonging to this security group.
<address>0..*An address belonging to this security group.

<user>

The <user> element represents a user in an ACL-based security model.

Attributes:

AttributeRequiredDescription
idyesUnique user identifier. Value must be a non-empty string.
hostnoThe user hostname or IP address as string. Must represent a resolvable server address.

<proxy>

The <proxy> element represents a storage proxy service settings. This element is used only with storage type "proxy". Available since IMiS/Storage Connector SOAP Service version 3.4.2103.

Attributes:

AttributeRequiredDescription
urlyesThe proxy service url address.
usernamenoThe proxy service authentication username.
passwordnoThe proxy service authentication password.
preemptiveauthenticationnoIf "true", uses preemptive basic authentication on proxy service. Valid values are "true" or "false" (case insensitive). When specified, username and password must be present.
targetnoThe proxy service target storage identifier. Value must be a non-empty string if attribute is present.

<address>

The <address> element represents a storage address or an address in an ACL-based security model.

Attributes:

AttributeRequiredDescription
hostyesThe hostname or IP address as string. Must represent a resolvable server address.
portyes untill version 3.4.2010, no since version 3.4.2103 if used in <storage>, no if used in <security>The port number for storage address.
primarynoIf "true", this address is a primary storage address. Valid values: "true" or "false" (case insensitive).

<authentication>

The <authentication> element is used to configure the authentication used when establishing a connection with IMiS/ARC Storage Server.

Attributes:

AttributeRequiredDescription
typeyesThe authentication type. Valid values are "none", "psk", "local" or "ldap" (case insensitive). Types "local" and "ldap" require IMiS/Storage Connector SOAP Service version 3.4.2010.
modeno if type="none"
yes if type="psk"
The authentication mode. Valid values are "aes-256-cbc", "aes-256-ecb", "aes-256-ofb", "aes-256-cfb", "aes-192-cbc", "aes-192-ecb", "aes-192-ofb", "aes-192-cfb", "aes-128-cbc", "aes-128-ecb", "aes-128-ofb" or "aes-128-cfb" (case insensitive).
usernameno if type="none" or "psk"
yes if type="local" or "ldap"
The username to be used during authentication process. This value prevails over the username passed in request's <auditlog> tag. Requires IMiS/Storage Connector SOAP Service version 3.4.2010.
keyno if type="none"
yes if type="psk", "local" or "ldap"
The authentication pre-shared key if type is "psk". The authentication password if type is "local" or "ldap". Value must be a non-empty string (case sensitive).
impersonatenoThe username to be used during authentication process for impersonalization purposes. Requires IMiS/Storage Connector SOAP Service version 3.4.2010.

<profile>

The <profile> element is used to define storage profiles.

Attributes:

AttributeRequiredDescription
nameyesStorage profile name. Valid value is an existing IMiS/ARC Storage Server profile (case insensitive).
defaultno (defaults to "false")If "true", this storage profile is a default profile for service requests that do not specify a storage profile. Valid values: "true" or "false" (case insensitive).
aclnoThe ACL configuration to use. Valid value is an existing <acl> element identifier (case insensitive).

<operation>

The <operation> element is used to set the ACL configuration for a specific service request. Currently the only operations are "getObject" and "storeObject".

Attributes:

AttributeRequiredDescription
nameyesOperation identifier. Valid values: "getobject" or "storeobject" (case insensitive).
aclnoThe ACL configuration to use. Valid value is an existing <acl> element identifier (case insensitive).

<auditlog>

The <auditlog> element is used to specify which data are being logged by IMiS/Storage Connector audit log.

Attributes:

AttributeRequiredDescription
userno (defaults to "false")If "true", user name specified by service request is passed to IMiS/Storage Connector audit log. Valid values: "true" or "false" (case insensitive).
computerno (defaults to "false")If "true", computer name specified by service request is passed to IMiS/Storage Connector audit log. Valid values: "true" or "false" (case insensitive).
addressno (defaults to "false")If "true", network address specified by service request will be passed to IMiS/Storage Connector audit log when supported. Valid values: "true" or "false" (case insensitive).
messageno (defaults to "false")If "true", audit log message specified by service request is passed to IMiS/Storage Connector audit log. Valid values: "true" or "false" (case insensitive).


Related Documents:



| Back | Main view