Tema anterior: Patrón de administración

Tema siguiente: Patrón de operaciones


Patrón de gestor

Todos los tipos de recursos tienen una interfaz de patrón de gestor. Esta interfaz se encarga de crear, leer, actualizar y suprimir (CRUD) instancias de este tipo. El patrón de URL es para poner en plural el nombre del tipo de recurso. Por ejemplo, grids o networks.

La acción POST se utiliza para crear una instancia de un tipo. La instrucción POST se aplica a la URL del gestor y define una carga útil para el tipo de recurso. Por ejemplo, para crear un grid, utilice una instrucción POST en /grids con una carga útil formada por el registro de grid.

La acción DELETE se utiliza para suprimir una instancia de un tipo de recurso. La URL para la supresión incluye el identificador único (ID, nombre, entre otros) para el tipo de recurso. Por ejemplo, DELETE /grids/govt_sales elimina el grid denominado govt_sales.

Las instancias de un tipo de recurso se pueden leer con GET. Esta acción devuelve una lista que contiene las instancias.

Para actualizar una instancia se utiliza PUT en la URL que contiene el identificador de la instancia y se incluye una carga útil que representa los atributos modificados y tipo de recurso de una manera similar a la descrita anteriormente en patrón de administración.

El patrón de gestor también se puede aplicar a atributos de la lista dentro de un tipo concreto, donde no se desee especificar la lista entera en una actualización. Por ejemplo, en lugar de utilizar PUT grids/admin con una carga de trabajo que contenga el registro del grid con la lista entera de ID de grids disponibles, utilice el patrón de gestor emitiendo una de las acciones CRUD para parámetros de grid individuales mediante la URL siguiente:

admin/grids/availableGridIds

Este patrón de URL se puede utilizar también para modificar relaciones de una instancia de tipo. Por ejemplo, si se aplica POST al atributo servers en un registro de grid, se agregará el servidor (especificado mediante la carga útil del registro del servidor) al grid, mientras que si se aplica DELETE al mismo registro, se eliminará el servidor.

Ejemplo de destino 1

BFC/<resource_type>s 

GET

Recupera las instancias gestionadas mediante este Gestor.

Valor devuelto: una lista con los registros del recurso.

POST

Crea una instancia gestionada mediante el Gestor.

Carga útil: registro del recurso.

Valor devuelto: nombre de la instancia.

Resultado: la instancia creada se agrega a recursos gestionados existentes.

Ejemplo de destino 2

BFC/<resource_type>s/<instance id> 

GET

Recupera la instancia identificada mediante la URL.

Valor devuelto: una lista con los registros del recurso.

PUT

Actualización: actualización de la instancia.

Carga útil: registro sucinto que contiene los atributos que se deben configurar.

Valor devuelto: Aceptar.

Resultado: se actualiza el recurso.

POST

Crea una conexión al recurso o al recurso secundario.

Carga útil: registro de recursos (sucinto, por ejemplo, solo el ID o la definición de los subcomponentes totalmente rellena).

Valor devuelto: identificador de instancia.

Resultado: el recurso se conecta a la instancia de recurso o se crea para dicha instancia.

DELETE

Suprima el recurso o deshaga la relación identificada por el recurso en la URL.

Carga útil: N/D.

Valor devuelto: Aceptar.

Resultado: se elimina instancia de los recursos gestionados existentes o la relación del recurso.