ZipUtils
Inclusion code:
| Service Deployment | |||
|---|---|---|---|
| Port Name | Location | Protocol | Interfaces | 
| ZipUtils documentation: | |||
| ZipUtils | - | - | ZipUtilsInterface | 
List of Available Interfaces
ZipUtilsInterface
Interface documentation:
| Operation Name | Input Type | Output Type | Faults | 
|---|---|---|---|
| zip | ZipRequest | raw | IOException( IOExceptionType ) | 
| IOException | undefined | undefined | |
| unzip | UnzipRequest | UnzipResponse | FileNotFound( undefined ) | 
| readEntry | ReadEntryRequest | any | IOException( IOExceptionType ) | 
| listEntries | ListEntriesRequest | ListEntriesResponse | IOException( IOExceptionType ) | 
Operation Description
zip
Operation documentation:
Invocation template:
zip@ZipUtils( request )( response )
Request type
Type: ZipRequest
type ZipRequest: undefined
ZipRequest : void
Response type
Type: raw
raw : raw
Possible faults thrown
Fault IOException with type IOExceptionType
Fault-handling install template:
install ( IOException => /* error-handling code */ )
type IOExceptionType: JavaExceptionType
IOException
Operation documentation:
Invocation template:
IOException@ZipUtils( request )( response )
Request type
Type: undefined
undefined : any
Response type
Type: undefined
undefined : any
unzip
Operation documentation:
Invocation template:
unzip@ZipUtils( request )( response )
Request type
Type: UnzipRequest
type UnzipRequest: void {
    .filename: string
    .targetPath: string
}
UnzipRequest : void
- filename : string
- targetPath : string
Response type
Type: UnzipResponse
type UnzipResponse: void {
    .entry*: string
}
UnzipResponse : void
- entry : string
Possible faults thrown
Fault FileNotFound with type undefined
Fault-handling install template:
install ( FileNotFound => /* error-handling code */ )
readEntry
Operation documentation:
Invocation template:
readEntry@ZipUtils( request )( response )
Request type
Type: ReadEntryRequest
type ReadEntryRequest: void {
    .entry: string
    .filename?: string
    .archive?: raw
}
ReadEntryRequest : void
- entry : string
- filename : string
- archive : raw
Response type
Type: any
any : any
Possible faults thrown
Fault IOException with type IOExceptionType
Fault-handling install template:
install ( IOException => /* error-handling code */ )
type IOExceptionType: JavaExceptionType
listEntries
Operation documentation:
Invocation template:
listEntries@ZipUtils( request )( response )
Request type
Type: ListEntriesRequest
type ListEntriesRequest: void {
    .filename?: string
    .archive?: raw
}
ListEntriesRequest : void
- filename : string
- archive : raw
Response type
Type: ListEntriesResponse
type ListEntriesResponse: void {
    .entry*: string
}
ListEntriesResponse : void
- entry : string
Possible faults thrown
Fault IOException with type IOExceptionType
Fault-handling install template:
install ( IOException => /* error-handling code */ )
type IOExceptionType: JavaExceptionType
Subtypes
JavaExceptionType
type JavaExceptionType: string { .stackTrace: string }