VServerAdmin

Esta clase se usa para realizar labores administrativas con el servidor de forma programada, similar a como se realizan visualmente con el componente Velneo vAdmin, por lo tanto, el usuario con el que ejecutemos las funciones de esta clase debe tener activada en Velneo vAdmin la propiedad supervisor:

El objeto theServerAdmin representa al servidor de aplicaciones (Velneo vServer) al que estamos conectados y nos permite acceder a toda la configuración de usuarios, grupos de usuarios, carpetas compartidas, soluciones y permisos tanto para su consulta como modificación.

El objeto está disponible en procesos en los clientes Velneo vClient, Velneo vDataClient. No está disponible para su ejecución en el servidor, se ha de usar en procesos del cliente en 1º o 2º plano.

En el caso de usar esta clase en procesos ejecutados con Velneo vClient o con Velneo vDataClient, la versión de éstos debe ser la misma que la del servidor, no puede ser distinta.

Indice de funciones

De errores

Number getLastErrorCode()

De usuarios

Boolean addUser( VUser user )

Booelan checkUserPassword( String userName, String password )

Boolean delUser( VUser user )

Booelan executableInstances( VInstancesList InstanceList, String usuario )

Boolean getAllUsers( VUserList userList )

Boolean getUserByEmail( String email, VUser user)

Boolean getUserById( VUser Number id, user )

Boolean getUserByName( VUser String name, user )

Boolean getUsersByGroup( VUserGroup VUserList userGroup, userList )

Boolean modUser( VUser user )

Boolean modUser( VUserList users)

De grupos de usuarios

Boolean addUserGroup( VUserGroup userGroup )

Boolean delUserGroup( VUserGroup userGroup )

Boolean getAllUserGroups( VUserGroupList userGroupList )

Boolean getUserGroupById( VUserGroup Number id, userGroup )

Boolean getUserGroupByName( VUserGroup String name, userGroup )

Boolean modUserGroup( VUserGroup userGroup )

Boolean modUserGroup(VUserGroupList userGroupList)

De soluciones

Array de Strings getSolutions()

De servidor

String getServerVrl()

Enumeraciones

ErrorCode

• ErrorUserAlreadyExist = 3

• ErrorUserNotFound = 2

• ErrorServerConnection = 1

• ErrorNone = 0

• ErrorUserGroupNotFound = 4

• ErrorUserGroupAlreadyExist = 5

• ErrorPermissions = 6

Documentación de funciones

Errores

Number getLastErrorCode()

Devuelve el último código de error generado. Revisar el enum ErrorCode para ver la lista de posibles errores devueltos.

Usuarios

Boolean addUser( VUser user )

Añade un usuario a la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• user: objeto de la clase VUser que contiene la información del usuario.

bool checkUserPassword( String userName, String password )

Devuelve true si la combinación de usuario-contraseña es correcta y false si la combinación usuario-contraseña es incorrecta.

Parámetros:

• userName: cadena de texto con el nombre del usuario.

• password: cadena de texto con la contraseña.

Boolean delUser( VUser user )

Elimina un usuario de la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• user: objeto de la clase VUser que contiene el usuario a eliminar.

Booelan executableInstances( VInstancesList InstanceList, String usuario )

Obtiene la lista de instancias ejecutables (las que carga vClient que tienen marco AUTOEXEC) para un usuario.

Parámetros:

• InstanceList: objeto de la clase VInstancesList con las instancias del usuario.
• usuario: nombre del usuario.

Esta función solamente puede ser ejecutada en cliente. No es funcional ni en procesos en tercer plano ni en Velneo vModapache en modo server.

Boolean getAllUsers( VUserList userList )

Obtiene una lista con todos los usuarios que están declarados en el servidor.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• userList: objeto de la clase VUserList que recibirá la lista de usuarios.

Boolean getUserByEmail( String email, VUser user)

Obtiene los datos del usuario de la base de datos del servidor cuyo email coincide con el primer parámetro de la función, dejando la información del usuario en el objeto de la clase VUser especificado en el segundo parámetro.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• email: email del usuario que queremos obtener.

• user: objeto de la clase VUser que recibirá la información del usuario.

Boolean getUserById( Number id, VUser user )

Obtiene los datos del usuario de la base de datos del servidor cuyo id coincide con el primer parámetro de la función, dejando la información del usuario en el objeto de la clase VUSer especificado en el segundo parámetro.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• id: código id del usuario que queremos obtener.

• user: objeto de la clase VUser que recibirá la información del usuario.

Boolean getUserByName( String name, VUser user )

Obtiene los datos del usuario de la base de datos del servidor cuyo nombre (name) coincide con el primer parámetro de la función, dejando la información del usuario en el objeto de la clase VUSer especificado en el segundo parámetro.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• name: nombre del usuario que queremos obtener.

• user: objeto de la clase VUser que recibirá la información del usuario.

Boolean getUsersByGroup( VUserGroup userGroup, VUserList userList )

Obtiene la lista de usuarios de la base de datos del servidor cuyo grupo coincida con el primer parámetro de la función, dejando la lista de usuarios en el objeto de la clase VUSerList especificado en el segundo parámetro.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• userGroup: objeto de la clase VUserGroup que corresponde a al grupo de usuarios a obtener.
• userList: objeto de la clase VUserList que recibirá la lista de usuarios del grupo.

Boolean modUser( VUser user )

Modifica los datos de un usuario de la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• user: objeto de la clase VUser que contiene la información del usuario.

Boolean modUser(VUserList users)

Modifica los datos de una lista de usuarios de la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• uses: objeto de la clase VUserList que contiene la lista de usuarios.

Grupos de usuarios

Boolean addUserGroup( VUserGroup userGroup )

Añade un grupo de usuarios a la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• userGroup: objeto de la clase VUserGroup que contiene la información del grupo de usuarios.

Boolean delUserGroup( VUserGroup userGroup )

Elimina un grupo de usuarios de la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• userGroup: objeto de la clase VUserGroup que contiene el grupo de usuarios a eliminar.

Boolean getAllUserGroups( VUserGroupList userGroupList )

Obtiene una lista con todos los grupos de usuarios que están declarados en el servidor.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• userGroupList: objeto de la clase VUserGroupList que recibirá la lista de grupos de usuarios.

Boolean getUserGroupById( Number id, VUserGroup userGroup )

Obtiene los datos del grupo de usuarios de la base de datos del servidor cuyo id coincide con el primer parámetro de la función, dejando la información del grupo de usuarios en el objeto de la clase VUSerGroup especificado en el segundo parámetro.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• id: código id del grupo de usuarios que queremos obtener.

• userGroup: objeto de la clase VUserGroup que recibirá la información del usuario.

Boolean getUserGroupByName( String name, VUserGroup userGroup )

Obtiene los datos del grupo de usuarios de la base de datos del servidor cuyo nombre (name) coincide con el primer parámetro de la función, dejando la información del grupo de usuarios en el objeto de la clase VUSerGroup especificado en el segundo parámetro.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• name: nombre del grupo de usuarios que queremos obtener.

• userGroup: objeto de la clase VUserGroup que recibirá la información del grupo de usuarios.

Boolean modUserGroup( VUserGroup userGroup )

Modifica los datos de un grupo de usuarios de la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• userGroup: objeto de la clase VUserGroup que contiene la información del grupo de usuarios.

Boolean modUserGroup( VUserGroupList UserGroups )

Modifica los datos de una lista de grupos de usuarios de la base de datos del servidor de aplicaciones.

Devuelve true si la operación ha finalizado correctamente o false en caso de que se haya producido un error. Para analizar el error producido debemos hacer uso de la función getLastErrorCode() y el enum ErrorCodes para conocer el origen del mismo.

Parámetros:

• userGroups: objeto de la clase VUserGroupList que contiene la lista de grupos de usuarios.

Soluciones

Array de Strings getSolutions()

Devuelve un array con los nombres de todas las soluciones que están declaradas en el servidor.

Servidor

String getServerVrl()

Devuelve una cadena con la VRL del servidor al que estamos conectados, sin incluir usuario y contraseña: vatps://dominio:puerto

bool executableInstances( VInstanceList pInstanceList, const QString& szUsuario )

Ejemplos

1 Modificar una propiedad de una lista de usuarios

var userList = new VUserList();
theServerAdmin.getAllUsers( userList );
for (var i = 0 ; i < userList.size() ; i++)
{
    var user = userList.getAt( i );
    if (user.name() !== "velneo")
    {
        user.setFullName( "Nombre desde JS" );
    }
}
theServerAdmin.modUser( userList );

2 Modificar una propiedad de una lista de grupos de usuarios

var groupList = new VUserGroupList();
theServerAdmin.getAllUserGroups( groupList );
for (var i = 0 ; i < groupList.size() ; i++)
{
    var grupo = groupList.getAt(i);
    if (grupo.name() !== "Administradores")
    {
        grupo.removeAllEditPermission();
    }
}
theServerAdmin.modUserGroup( groupList );

Obtener lista de instancias de aplicación de un usuario

importApi("AdminApi");
var listaInstancias = new VInstanceList();
if (theServerAdmin.executableInstances(listaInstancias, "velneo"))
{
     for (var num = 0; num < listaInstancias.size(); num++)
     {
          var instance = listaInstancias.getAt(num);
          alert("Instancia: " + instance.name());
     }
}