December 24 - AppLogic 2.4.7 is now available and is the latest production release!
Class Management Commands
The following commands are supported:
| Command | Description |
|---|
| list | Retrieve list of classes in a package |
| move | Move a class |
| copy | Copy a class |
| delete | Delete a class |
| export | Export a class |
| import | Import a class |
| get_desc | Display class descriptor (Supported in Applogic 2.3.0+) |
| put_desc | Modify class descriptor (Supported in Applogic 2.3.0+) |
| lock | Lock a class (Supported in Applogic 2.1.1 with hotfix e2106 or later) |
| unlock | Unlock a class (Supported in Applogic 2.1.1 with hotfix e2106 or later) |
list
| Description: | List classes in a package |
| Syntax: | class list package [ --batch ] [ --verbose ] |
| Arguments: | package | Name of package for which to list classes. package may be one of the following: |
| application - list singleton classes of application |
| application/catalog - list classes in local catalog |
| /catalog - list classes in global catalog |
| --batch | Display output in UDL format |
| --verbose | Display total volume size for each class as well as protocols. |
| Examples: | class list sugarcrm - List classes of application |
| class list sugarcrm/local - List classes of application local catalog |
| class list /system - List classes of global catalog |
| Notes: | A specification of the output of this command can be foundhere. |
Typical Output
Classes in catalog 'system':
Class Category Description
--------------------------------------------------------------------------------
WEB Web Servers Simple Web Server (version 3.0.0)\r\nApache, PHP, mod_perl,and MYSQL Client libs installed.
NET Gateways Network output gateway, (version 2.0.0)
NAS Misc. Appliances NAS Appliance (version 2.0.0)\r\nprovides file storage accessible over HTTP and CIFS file protocols
OUT Gateways Firewalled output gateway (version 2.0.0)
LUX General Generic Linux-based appliance, version 1.4
HLB Switches Session-aware HTTP Load Balancer (version 2.0.0)
MYSQL Database Appliances MYSQL Database appliance based on mysql 4.0.18 (version 2.0.0)
IN Gateways Incoming connection gateway with firewall (version - 2.0.0)
move
| Description: | Move a class from one package to another and/or rename the class. |
| Syntax: | class move source destination |
| Arguments: | source | Name of class that is to be moved |
| destination | New class name |
| Examples: | class move /system:NAS sugarcrm/local:NAS - move class from global catalog to local application catalog |
| class move /system:NAS sugarcrm:NAS - move class from global catalog to application singleton |
| class move sugarcrm:NAS /system:NAS - move application singleton class to global catalog |
| Notes: | The move command can move a class: |
| a) from one catalog to another; |
| b) from a catalog to a singleton; |
| c) from singleton to application catalog class. |
| The move command can be used to rename a class within a catalog and/or the application package. |
| Note that a singleton assembly (an assembly class in the application package) cannot be moved to a catalog if any of its subordinates is a singleton. This is because having a singleton subordinate would prevent the instantiation of such class. |
| Also note that moving a class will not automatically change the .class attribute of subordinates using this class - this needs to be done manually in all affected assemblies. |
copy
| Description: | Copy a class from one package to another. |
| Syntax: | class copy source destination |
| Arguments: | source | Name of class that is to be copied |
| destination | New class name |
| Examples: | class copy /system:NAS sugarcrm/local:NAS - copy class from global catalog to local application catalog |
| class copy /system:NAS sugarcrm:NAS - copy class from global catalog to application singleton |
| class copy sugarcrm:NAS /system:NAS - copy application singleton class to global catalog |
| Notes: | Classes can be copied: |
| a) from one catalog to another, |
| b) from a catalog to an application singleton, |
| c) from application singleton to a catalog. |
destroy
| Description: | Delete a class and all its class volumes from a catalog or application. |
| Syntax: | class destroy class [ --force ] |
| Arguments: | class | Name of the class to be deleted; the class may be in a global catalog, application-specific catalog, or it may be a singleton. |
| --force | option to skip the confirmation prompt |
| Examples: | class destroy sugarcrm:NAS - Destroy application singleton class |
| class destroy sugarcrm/local:NAS - Destroy application local catalog class |
| class destroy /system:NAS - Destroy global catalog class |
| Notes: | Instances of the deleted class are not automatically deleted from any application. |
export
| Description: | Export a class |
| Syntax: | class export class dir [ --force ] [ --nocompress ] |
| Arguments: | class | name of class to be exported. May specify one of the following: |
| application/catalog:class - export local application catalog class |
| /catalog:class - export global catalog class |
| dir | Name of exchange directory relative to /vol/_impex where class is to be exported to |
| --force | Option to allow exporting of class even if it is already present (i.e., the class is removed and then exported) |
| --nocompress | Do not compress class volumes. |
| Examples: | class export sugarcrm/local:NAS nas - Export application local catalog class |
| class export /system:NAS nas - Export global catalog class |
| Notes: | None. |
import
| Description: | Import a class |
| Syntax: | class import class dir [ --force ] |
| Arguments: | class | name of class to be imported. May specify one of the following: |
| application/catalog:class - import local application catalog class |
| /catalog:class - import global catalog class |
| dir | Name of exchange directory relative to /vol/_impex where class is to be imported from |
| --force | Option to allow importing of class even if it is already present (i.e., the class is removed and then imported) |
| Examples: | class import sugarcrm/local:NAS nas - Import application local catalog class |
| class import /system:NAS nas - Import global catalog class |
| Notes: | None. |
get_desc
| Description: | Display class descriptor |
| Syntax: | class get_desc class |
| Arguments: | class | name of class for which to display descriptor May specify one of the following: |
| application:class - display application singleton class descriptor |
| application/catalog:class - display application local catalog class descriptor |
| /catalog:class - display global catalog class descriptor |
| Examples: | class get_desc /system:MYCLASS - display global catalog class descriptor |
| class get_desc myapp:MYCLASS - display application singleton class descriptor |
| Notes: | Supported in Applogic 2.3.0+ |
put_desc
| Description: | Modify class descriptor |
| Syntax: | class put_desc class |
| Arguments: | class | name of class for which to modify descriptor May specify one of the following: |
| application:class - modify application singleton class descriptor |
| application/catalog:class - modify application local catalog class descriptor |
| /catalog:class - modify global catalog class descriptor |
| Examples: | class put_desc /system:MYCLASS - modify global catalog class descriptor |
| class put_desc myapp:MYCLASS - modify application singleton class descriptor |
| Notes: | Supported in Applogic 2.3.0+ |
| The new descriptor is obtained from standard input. |
| The name of the class may not be changed within the new descriptor. |
| The locked attribute may not be changed within the new descriptor if executed by a non-maintainer. |
lock
| Description: | lock a class |
| Syntax: | class lock class |
| Arguments: | class | name of class to be locked May specify one of the following: |
| application:class - lock application singleton class |
| /catalog:class - lock global catalog class |
| Examples: | class lock /system:MYCLASS - Lock global catalog class |
| class lock myapp:MYCLASS - Lock application singleton class |
| Notes: | This command is supported in AppLogic 2.1.1 with hotfix e2106 or later |
| This command is available to grid maintainers ONLY! |
When a class is locked, the following operations cannot be executed by non-maintainers:
* class branch
* class copy
* class move
* class get_desc
* export of class or catalog/application containing the class
* mounting/modifying/reading of class volumes |
unlock
| Description: | unlock a class |
| Syntax: | class unlock class |
| Arguments: | class | name of class to be unlocked May specify one of the following: |
| application:class - lock application singleton class |
| /catalog:class - lock global catalog class |
| Examples: | class unlock /system:MYCLASS - Unlock global catalog class |
| class unlock myapp:MYCLASS - Unlock application singleton class |
| Notes: | This command is supported in AppLogic 2.1.1 with hotfix e2106 or later |
| This command is available to grid maintainers ONLY! |
--
BeckyH - 23 May 2006
AppLogic2 Web