Internal Tunnel API

LockManager

Other API in Package

Web

User

Internal Web

Tunnel

List of Classes

InternalTunnelController

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsolePacket

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportProfile

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelRequest

TunnelResponse

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Provides a locking mechanism.

Method Summary
boolean createLock(String objectKey, String sessionKey, Date expires)

Sets a self expiring lock for the given key. The lock will expire as of the date/time indicated. Maximum lock time is 1 hour.

  deleteLock(String objectKey)

Deletes the specified lock

Date getExpire(String objectKey, String sessionKey)

Returns the expiration, if any, for the specified objectKey. If sessionKey is provided, this returns the expire datetime only if the sessionKey has the lock.

String getSessionKey(String objectKey)

Returns the session key, if any, for the specified objectKey.

boolean hasLock(String objectKey, String sessionKey)

Returns true if the specified sessionKey has a lock on the objectKey. If sessionKey is provided, this returns the expire datetime only if the sessionKey has the lock.

String toString()

Returns a description of this object.

Method Detail


boolean createLock(String objectKey, String sessionKey, Date expires)

Sets a self expiring lock for the given key. The lock will expire as of the date/time indicated. Maximum lock time is 1 hour.

Parameters:

  • String   objectKey Required parameter. Maximum allowed size of parameter: 128
  • String   sessionKey Required parameter. Maximum allowed size of parameter: 128
  • Date   expires Required parameter.

Returns:  boolean

Since: 11-10-2015

top

deleteLock(String objectKey)

Deletes the specified lock

Parameters:

  • String   objectKey Required parameter. Maximum allowed size of parameter: 128

Since: 11-10-2015

top

Date getExpire(String objectKey, String sessionKey)

Returns the expiration, if any, for the specified objectKey. If sessionKey is provided, this returns the expire datetime only if the sessionKey has the lock.

Parameters:

  • String   objectKey Required parameter. Maximum allowed size of parameter: 128
  • String   sessionKey Maximum allowed size of parameter: 128

Returns:  Date

Since: 11-10-2015

top

String getSessionKey(String objectKey)

Returns the session key, if any, for the specified objectKey.

Parameters:

  • String   objectKey Required parameter. Maximum allowed size of parameter: 128

Returns:  String

Since: 11-10-2015

top

boolean hasLock(String objectKey, String sessionKey)

Returns true if the specified sessionKey has a lock on the objectKey. If sessionKey is provided, this returns the expire datetime only if the sessionKey has the lock.

Parameters:

  • String   objectKey Required parameter. Maximum allowed size of parameter: 128
  • String   sessionKey Maximum allowed size of parameter: 128

Returns:  boolean

Since: 11-10-2015

top

String toString()

Returns a description of this object.

Returns:  String

Since: 11-10-2015

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM