BaseSubscriptionInfo (bw-synch-shared 4.0.0 API)

java.lang.Object
- org.bedework.synch.shared.BaseSubscriptionInfo

```
public class BaseSubscriptionInfo
extends Object
```
Provides an internal deserialized view of the subscription info for one end. A number of common methods are provided here and it is assumed that connectors and instances will subclass this class.

Author:

Mike Douglass

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseSubscriptionInfo.CrudCts
maintain some counts

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseSubscriptionInfo.CrudCts` maintain some counts

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`propnameChangeToken` The value of some sort of change token.
`static String`	`propnameInputFilterClasses` Comma separatd list of input filter property classes
`static String`	`propnameLastCrudCts` The numbers created, updated, deleted last time
`static String`	`propnameLastRefreshStatus` A string value that provides information about the last refresh for this end of the subscription
`static String`	`propnameLocKey` Location key name for matching
`static String`	`propnameOpaqueData` Opaque data for this connection
`static String`	`propnameOrgSyncPublicOnly` Allow only public entities
`static String`	`propnameOutputFilterClasses` Comma separated list of output filter property classes
`static String`	`propnamePassword` The (encoded) password for the principal
`static String`	`propnamePrincipal` A principal - possibly an href or an account
`static String`	`propnameRefreshDelay` Refresh period for polling subscriptions (millisecs)
`static String`	`propnameTotalCrudCts` The numbers created, updated, deleted this subscription
`static String`	`propnameUri` A uri referring to the endpoint.

Constructor Summary

Constructors
Constructor and Description

BaseSubscriptionInfo(SubscriptionConnectorInfo info)

Constructors
Constructor and Description
`BaseSubscriptionInfo(SubscriptionConnectorInfo info)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getChangeToken()` ChangeToken
`List<String>`	`getInFilterClasses()`
`BaseSubscriptionInfo.CrudCts`	`getLastCrudCts()`
`String`	`getLastRefreshStatus()`
`String`	`getOpaqueData()` Opaque data for the connection
`List<String>`	`getOutFilterClasses()`
`String`	`getPassword()` Principal password
`String`	`getPrincipalHref()` Principal requesting synch service
`String`	`getProperty(String name)` Get arbitrary named property
`String`	`getRefreshDelay()` Refresh delay - millisecs
`BaseSubscriptionInfo.CrudCts`	`getTotalCrudCts()`
`String`	`getUri()` Path to the calendar collection
`void`	`setChangeToken(String val)` ChangeToken
`void`	`setInFilterClasses(List<String> classes)`
`void`	`setLastCrudCts(BaseSubscriptionInfo.CrudCts val)`
`void`	`setLastRefreshStatus(String val)` HTTP status or other appropriate value
`void`	`setOpaqueData(String val)` Opaque data for the connection
`void`	`setOutFilterClasses(List<String> classes)`
`void`	`setPassword(String val)` Principals password
`void`	`setPrincipalHref(String val)` Principal requesting synch service
`void`	`setProperty(String name, String val)` set arbitrary named property
`void`	`setRefreshDelay(String val)` Refresh delay - millisecs
`void`	`setTotalCrudCts(BaseSubscriptionInfo.CrudCts val)`
`void`	`setUri(String val)` Path to the calendar collection.
`String`	`toString()`
`protected void`	`toStringSegment(org.bedework.util.misc.ToString ts)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - propnameUri
```
public static final String propnameUri
```
    A uri referring to the endpoint. Perhaps the URL of a file or the href for a caldav collection
    
    See Also:
    
    Constant Field Values
  - propnameChangeToken
```
public static final String propnameChangeToken
```
    The value of some sort of change token. This could be a caldav ctag or an http etag.
    
    See Also:
    
    Constant Field Values
  - propnameOpaqueData
```
public static final String propnameOpaqueData
```
    Opaque data for this connection
    
    See Also:
    
    Constant Field Values
  - propnamePrincipal
```
public static final String propnamePrincipal
```
    A principal - possibly an href or an account
    
    See Also:
    
    Constant Field Values
  - propnamePassword
```
public static final String propnamePassword
```
    The (encoded) password for the principal
    
    See Also:
    
    Constant Field Values
  - propnameRefreshDelay
```
public static final String propnameRefreshDelay
```
    Refresh period for polling subscriptions (millisecs)
    
    See Also:
    
    Constant Field Values
  - propnameOrgSyncPublicOnly
```
public static final String propnameOrgSyncPublicOnly
```
    Allow only public entities
    
    See Also:
    
    Constant Field Values
  - propnameLocKey
```
public static final String propnameLocKey
```
    Location key name for matching
    
    See Also:
    
    Constant Field Values
  - propnameLastRefreshStatus
```
public static final String propnameLastRefreshStatus
```
    A string value that provides information about the last refresh for this end of the subscription
    
    See Also:
    
    Constant Field Values
  - propnameLastCrudCts
```
public static final String propnameLastCrudCts
```
    The numbers created, updated, deleted last time
    
    See Also:
    
    Constant Field Values
  - propnameTotalCrudCts
```
public static final String propnameTotalCrudCts
```
    The numbers created, updated, deleted this subscription
    
    See Also:
    
    Constant Field Values
  - propnameInputFilterClasses
```
public static final String propnameInputFilterClasses
```
    Comma separatd list of input filter property classes
    
    See Also:
    
    Constant Field Values
  - propnameOutputFilterClasses
```
public static final String propnameOutputFilterClasses
```
    Comma separated list of output filter property classes
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseSubscriptionInfo
```
public BaseSubscriptionInfo(SubscriptionConnectorInfo info)
                     throws SynchException
```
    Parameters:
    
    info - subscription connector info
    
    Throws:
    
    SynchException
- Method Detail
  - setUri
```
public void setUri(String val)
            throws SynchException
```
    Path to the calendar collection.
    
    Parameters:
    
    val - String
    
    Throws:
    
    SynchException
  - getUri
```
public String getUri()
              throws SynchException
```
    Path to the calendar collection
    
    Returns:
    
    String
    
    Throws:
    
    SynchException
  - setPrincipalHref
```
public void setPrincipalHref(String val)
                      throws SynchException
```
    Principal requesting synch service
    
    Parameters:
    
    val - String
    
    Throws:
    
    SynchException
  - getPrincipalHref
```
public String getPrincipalHref()
                        throws SynchException
```
    Principal requesting synch service
    
    Returns:
    
    String
    
    Throws:
    
    SynchException
  - setPassword
```
public void setPassword(String val)
                 throws SynchException
```
    Principals password
    
    Parameters:
    
    val - String
    
    Throws:
    
    SynchException
  - getPassword
```
public String getPassword()
                   throws SynchException
```
    Principal password
    
    Returns:
    
    String
    
    Throws:
    
    SynchException
  - setOpaqueData
```
public void setOpaqueData(String val)
                   throws SynchException
```
    Opaque data for the connection
    
    Parameters:
    
    val - String
    
    Throws:
    
    SynchException
  - getOpaqueData
```
public String getOpaqueData()
                     throws SynchException
```
    Opaque data for the connection
    
    Returns:
    
    String
    
    Throws:
    
    SynchException
  - setChangeToken
```
public void setChangeToken(String val)
                    throws SynchException
```
    ChangeToken
    
    Parameters:
    
    val - String
    
    Throws:
    
    SynchException
  - getChangeToken
```
public String getChangeToken()
                      throws SynchException
```
    ChangeToken
    
    Returns:
    
    String
    
    Throws:
    
    SynchException
  - setLastRefreshStatus
```
public void setLastRefreshStatus(String val)
                          throws SynchException
```
    HTTP status or other appropriate value
    
    Parameters:
    
    val - status
    
    Throws:
    
    SynchException
  - getLastRefreshStatus
```
public String getLastRefreshStatus()
                            throws SynchException
```
    Returns:
    
    String lastRefreshStatus
    
    Throws:
    
    SynchException
  - setLastCrudCts
```
public void setLastCrudCts(BaseSubscriptionInfo.CrudCts val)
                    throws SynchException
```
    Parameters:
    
    val - crud counts
    
    Throws:
    
    SynchException
  - getLastCrudCts
```
public BaseSubscriptionInfo.CrudCts getLastCrudCts()
                                            throws SynchException
```
    Returns:
    
    cts
    
    Throws:
    
    SynchException
  - setTotalCrudCts
```
public void setTotalCrudCts(BaseSubscriptionInfo.CrudCts val)
                     throws SynchException
```
    Parameters:
    
    val - crud counts
    
    Throws:
    
    SynchException
  - getTotalCrudCts
```
public BaseSubscriptionInfo.CrudCts getTotalCrudCts()
                                             throws SynchException
```
    Returns:
    
    cts
    
    Throws:
    
    SynchException
  - setRefreshDelay
```
public void setRefreshDelay(String val)
                     throws SynchException
```
    Refresh delay - millisecs
    
    Parameters:
    
    val - millisecs
    
    Throws:
    
    SynchException
  - getRefreshDelay
```
public String getRefreshDelay()
                       throws SynchException
```
    Refresh delay - millisecs
    
    Returns:
    
    String refreshDelay
    
    Throws:
    
    SynchException
  - setProperty
```
public void setProperty(String name,
                        String val)
                 throws SynchException
```
    set arbitrary named property
    
    Parameters:
    
    name - of property
    
    val - - String property value
    
    Throws:
    
    SynchException
  - getProperty
```
public String getProperty(String name)
                   throws SynchException
```
    Get arbitrary named property
    
    Parameters:
    
    name - of property
    
    Returns:
    
    String property value
    
    Throws:
    
    SynchException
  - setInFilterClasses
```
public void setInFilterClasses(List<String> classes)
                        throws SynchException
```
    Parameters:
    
    classes - ordered list of class names
    
    Throws:
    
    SynchException
  - getInFilterClasses
```
public List<String> getInFilterClasses()
                                throws SynchException
```
    Returns:
    
    ordered list of class names
    
    Throws:
    
    SynchException
  - setOutFilterClasses
```
public void setOutFilterClasses(List<String> classes)
                         throws SynchException
```
    Parameters:
    
    classes - ordered list of class names
    
    Throws:
    
    SynchException
  - getOutFilterClasses
```
public List<String> getOutFilterClasses()
                                 throws SynchException
```
    Returns:
    
    ordered list of class names
    
    Throws:
    
    SynchException
  - toStringSegment
```
protected void toStringSegment(org.bedework.util.misc.ToString ts)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BaseSubscriptionInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

propnameUri

propnameChangeToken

propnameOpaqueData

propnamePrincipal

propnamePassword

propnameRefreshDelay

propnameOrgSyncPublicOnly

propnameLocKey

propnameLastRefreshStatus

propnameLastCrudCts

propnameTotalCrudCts

propnameInputFilterClasses

propnameOutputFilterClasses

Constructor Detail

BaseSubscriptionInfo

Method Detail

setUri

getUri

setPrincipalHref

getPrincipalHref

setPassword

getPassword

setOpaqueData

getOpaqueData

setChangeToken

getChangeToken

setLastRefreshStatus

getLastRefreshStatus

setLastCrudCts

getLastCrudCts

setTotalCrudCts

getTotalCrudCts

setRefreshDelay

getRefreshDelay

setProperty

getProperty

setInFilterClasses

getInFilterClasses

setOutFilterClasses

getOutFilterClasses

toStringSegment

toString