Installable services interface reference information on IBM i

Use this information to understand the reference information for the installable services for IBM i.

For each function there is a description, including the function identifier (for MQZEP).

The parameters are shown listed in the order they must occur. They must all be present.

Each parameter name is followed by its data type in parentheses. These are the elementary data types described in Elementary data types.

The C language invocation is also given, after the description of the parameters.

• MQZEP (Add component entry point) on IBM i
  This function is invoked by a service component, during initialization, to add an entry point to the entry point vector for that service component.
• MQHCONFIG (Configuration handle) on IBM i
  The MQHCONFIG data type represents a configuration handle, that is, the component that is being configured for a particular installable service. A configuration handle must be aligned on its natural boundary.
• PMQFUNC (Pointer to function) on IBM i
  Pointer to a function.
• MQZ_AUTHENTICATE_USER (Authenticate user) on IBM i
  This function is provided by a MQZAS_VERSION_5 authorization service component. It is invoked by the queue manager to authenticate a user, or to set identity context fields.
• MQZ_CHECK_AUTHORITY (Check authority) on IBM i
  This function is provided by a MQZAS_VERSION_1 authorization service component, and is invoked by the queue manager to check whether an entity has authority to perform a particular action, or actions, on a specified object.
• MQZ_CHECK_PRIVILEGED - Check if user is privileged
  This function is provided by an MQZAS_VERSION_6 authorization service component, and is invoked by the queue manager to determine whether a specified user is a privileged user.
• MQZ_COPY_ALL_AUTHORITY (Copy all authority) on IBM i
  This function is provided by an authorization service component. It is invoked by the queue manager to copy all of the authorizations that are currently in force for a reference object to another object.
• MQZ_DELETE_AUTHORITY (Delete authority) on IBM i
  This function is provided by an authorization service component, and is invoked by the queue manager to delete all of the authorizations associated with the specified object.
• MQZ_ENUMERATE_AUTHORITY_DATA (Enumerate authority data) on IBM i
  This function is provided by an MQZAS_VERSION_4 authorization service component, and is invoked repeatedly by the queue manager to retrieve all of the authority data that matches the selection criteria specified on the first invocation.
• MQZ_FREE_USER - Free user
  This function is provided by a MQZAS_VERSION_5 authorization service component, and is invoked by the queue manager to free associated allocated resource. It is invoked when an application has finished running under all user contexts, for example during an MQDISC MQI call.
• MQZ_GET_AUTHORITY (Get authority) on IBM i
  This function is provided by a MQZAS_VERSION_1 authorization service component, and is invoked by the queue manager to retrieve the authority that an entity has to access the specified object.
• MQZ_GET_EXPLICIT_AUTHORITY (Get explicit authority) on IBM i
  This function is provided by a MQZAS_VERSION_1 authorization service component, and is invoked by the queue manager to retrieve the authority that a named group has to access a specified object (but without the additional authority of the nobody group), or the authority that the primary group of the named principal has to access a specified object.
• MQZ_INIT_AUTHORITY (Initialize authorization service) on IBM i
  This function is provided by an authorization service component, and is invoked by the queue manager during configuration of the component. It is expected to call MQZEP in order to provide information to the queue manager.
• MQZ_INQUIRE (Inquire authorization service) on IBM i
  This function is provided by a MQZAS_VERSION_5 authorization service component, and is invoked by the queue manager to query the supported functionality. Where multiple service components are used, service components are called in reverse order to the order they were installed in.
• MQZ_REFRESH_CACHE (Refresh all authorizations) on IBM i
  This function is provided by an MQZAS_VERSION_3 authorization service component. It is invoked by the queue manager to refresh the list of authorizations held internally by the component.
• MQZ_SET_AUTHORITY (Set authority) on IBM i
  This function is provided by a MQZAS_VERSION_1 authorization service component, and is invoked by the queue manager to set the authority that an entity has to access the specified object.
• MQZ_TERM_AUTHORITY - Terminate authorization service
  This function is provided by an authorization service component, and is invoked by the queue manager when it no longer requires the services of this component. The function must perform any cleanup required by the component.
• MQZAC (Application context) on IBM i
  This parameter specifies data related to the calling application.
• MQZAD (Authority data) on IBM i
  The MQZAD structure is used on the MQZ_ENUMERATE_AUTHORITY_DATA call for two parameters.
• MQZED (Entity descriptor) on IBM i
  The MQZED structure is used in a number of authorization service calls to specify the entity for which authorization is to be checked.
• MQZFP (Free parameters) on IBM i
  This parameter specifies data related to resource to be freed.
• MQZIC (Identity context) on IBM i
  The MQZIC structure is used on the MQZ_AUTHENTICATE_USER call for the IdentityContext parameter.

Parent topic: User exits, API exits, and installable services reference

Related reference

• Installable services interface reference information

Related information

• Installable services and components for IBM i
• Installable services and components for UNIX, Linux and Windows