| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AppointmentManager (Openmeetings Service 7.2.0 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.openmeetings.service.calendar.caldav, class: AppointmentManager"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/AppointmentManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.openmeetings.service.calendar.caldav</a></div> |
| <h1 title="Class AppointmentManager" class="title">Class AppointmentManager</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.openmeetings.service.calendar.caldav.AppointmentManager</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Component |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">AppointmentManager</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Class which does syncing and provides respective API's required for performing CalDAV Operations.</div> |
| <dl class="notes"> |
| <dt>Author:</dt> |
| <dd>Ankush Mishra (ankushmishra9@gmail.com)</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AppointmentManager</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cleanupIdleConnections()" class="member-name-link">cleanupIdleConnections</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Cleans up unused idle connections.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createCalendar(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar)" class="member-name-link">createCalendar</a><wbr>(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create or Update calendar on the database.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.http.client.HttpClient</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createHttpClient()" class="member-name-link">createHttpClient</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a new HttpClient with the inbuilt connection manager in this.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteCalendar(org.apache.openmeetings.db.entity.calendar.OmCalendar)" class="member-name-link">deleteCalendar</a><wbr>(<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deletes the calendar from the local database.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteItem(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.Appointment)" class="member-name-link">deleteItem</a><wbr>(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Delete Appointment on the CalDAV server.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#destroy()" class="member-name-link">destroy</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Method which is called when the Context is destroyed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCalendars()" class="member-name-link">getCalendars</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCalendars(java.lang.Long)" class="member-name-link">getCalendars</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> userid)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Method to get user's calendars |
| please see <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dao/calendar/OmCalendarDao.html#getByUser(java.lang.Long)" title="class or interface in org.apache.openmeetings.db.dao.calendar" class="external-link"><code>OmCalendarDao.getByUser(Long)</code></a></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGoogleCalendars(java.lang.Long)" class="member-name-link">getGoogleCalendars</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> userId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Method to get user's google calendars |
| please see <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dao/calendar/OmCalendarDao.html#getGoogleCalendars(java.lang.Long)" title="class or interface in org.apache.openmeetings.db.dao.calendar" class="external-link"><code>OmCalendarDao.getGoogleCalendars(Long)</code></a></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTokenFromProperty(org.apache.jackrabbit.webdav.property.DavProperty)" class="member-name-link">getTokenFromProperty</a><wbr>(org.apache.jackrabbit.webdav.property.DavProperty<?> property)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the String value of the property, else null.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#provideCredentials(org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar,org.apache.http.auth.Credentials)" class="member-name-link">provideCredentials</a><wbr>(org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar, |
| org.apache.http.auth.Credentials credentials)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds the Credentials provided to the given client on the Calendar's URL.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#syncItem(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar)" class="member-name-link">syncItem</a><wbr>(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Function which when called performs syncing based on the type of Syncing detected.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#syncItems(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,java.lang.Long)" class="member-name-link">syncItems</a><wbr>(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> userId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Syncs all the calendars currrently present on the DB.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#testConnection(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar)" class="member-name-link">testConnection</a><wbr>(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tests if the Calendar's URL can be accessed, or not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateItem(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.Appointment)" class="member-name-link">updateItem</a><wbr>(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Function for create/updating multiple appointment on the server.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>AppointmentManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AppointmentManager</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createHttpClient()"> |
| <h3>createHttpClient</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.http.client.HttpClient</span> <span class="element-name">createHttpClient</span>()</div> |
| <div class="block">Returns a new HttpClient with the inbuilt connection manager in this.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>HttpClient object that was created.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="provideCredentials(org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar,org.apache.http.auth.Credentials)"> |
| <h3>provideCredentials</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">provideCredentials</span><wbr><span class="parameters">(org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar, |
| org.apache.http.auth.Credentials credentials)</span></div> |
| <div class="block">Adds the Credentials provided to the given client on the Calendar's URL.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - Context of the Client which makes the connection.</dd> |
| <dd><code>calendar</code> - Calendar whose Host the Credentials are for.</dd> |
| <dd><code>credentials</code> - Credentials to add</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="testConnection(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar)"> |
| <h3>testConnection</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">testConnection</span><wbr><span class="parameters">(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</span></div> |
| <div class="block">Tests if the Calendar's URL can be accessed, or not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>client</code> - Client which makes the connection.</dd> |
| <dd><code>context</code> - http context</dd> |
| <dd><code>calendar</code> - Calendar whose URL is to be accessed.</dd> |
| <dt>Returns:</dt> |
| <dd>Returns true for HTTP Status 200, or 204, else false.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createCalendar(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar)"> |
| <h3>createCalendar</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">createCalendar</span><wbr><span class="parameters">(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</span></div> |
| <div class="block">Create or Update calendar on the database.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>client</code> - - <code>HttpClient</code> to discover calendar</dd> |
| <dd><code>context</code> - http context</dd> |
| <dd><code>calendar</code> - - calendar to be created</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if calendar was created/updated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteCalendar(org.apache.openmeetings.db.entity.calendar.OmCalendar)"> |
| <h3>deleteCalendar</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">deleteCalendar</span><wbr><span class="parameters">(<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</span></div> |
| <div class="block">Deletes the calendar from the local database.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>calendar</code> - Calendar to delete</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCalendars()"> |
| <h3>getCalendars</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a>></span> <span class="element-name">getCalendars</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCalendars(java.lang.Long)"> |
| <h3>getCalendars</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a>></span> <span class="element-name">getCalendars</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> userid)</span></div> |
| <div class="block">Method to get user's calendars |
| please see <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dao/calendar/OmCalendarDao.html#getByUser(java.lang.Long)" title="class or interface in org.apache.openmeetings.db.dao.calendar" class="external-link"><code>OmCalendarDao.getByUser(Long)</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>userid</code> - - id of the user</dd> |
| <dt>Returns:</dt> |
| <dd>the list of the calendars</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGoogleCalendars(java.lang.Long)"> |
| <h3>getGoogleCalendars</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a>></span> <span class="element-name">getGoogleCalendars</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> userId)</span></div> |
| <div class="block">Method to get user's google calendars |
| please see <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dao/calendar/OmCalendarDao.html#getGoogleCalendars(java.lang.Long)" title="class or interface in org.apache.openmeetings.db.dao.calendar" class="external-link"><code>OmCalendarDao.getGoogleCalendars(Long)</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>userId</code> - - id of the user</dd> |
| <dt>Returns:</dt> |
| <dd>the list of the calendars</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="syncItem(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.OmCalendar)"> |
| <h3>syncItem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">syncItem</span><wbr><span class="parameters">(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a> calendar)</span></div> |
| <div class="block">Function which when called performs syncing based on the type of Syncing detected.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>client</code> - - <code>HttpClient</code> to discover calendar</dd> |
| <dd><code>context</code> - http context</dd> |
| <dd><code>calendar</code> - Calendar who's sync has to take place</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="syncItems(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,java.lang.Long)"> |
| <h3>syncItems</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">syncItems</span><wbr><span class="parameters">(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> userId)</span></div> |
| <div class="block">Syncs all the calendars currrently present on the DB.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>client</code> - - <code>HttpClient</code> to discover calendar</dd> |
| <dd><code>context</code> - http context</dd> |
| <dd><code>userId</code> - - id of the user</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateItem(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.Appointment)"> |
| <h3>updateItem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">updateItem</span><wbr><span class="parameters">(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</span></div> |
| <div class="block">Function for create/updating multiple appointment on the server. |
| Performs modification alongside of creation new events on the server.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>client</code> - - <code>HttpClient</code> to discover calendar</dd> |
| <dd><code>context</code> - http context</dd> |
| <dd><code>appointment</code> - Appointment to create/update.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> in case item was updated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteItem(org.apache.http.client.HttpClient,org.apache.http.client.protocol.HttpClientContext,org.apache.openmeetings.db.entity.calendar.Appointment)"> |
| <h3>deleteItem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">deleteItem</span><wbr><span class="parameters">(org.apache.http.client.HttpClient client, |
| org.apache.http.client.protocol.HttpClientContext context, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</span></div> |
| <div class="block">Delete Appointment on the CalDAV server. |
| Delete's on the Server only if the ETag of the Appointment is the one on the server, |
| i.e. only if the Event hasn't changed on the Server.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>client</code> - - <code>HttpClient</code> to discover calendar</dd> |
| <dd><code>context</code> - http context</dd> |
| <dd><code>appointment</code> - Appointment to Delete</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> in case item was deleted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTokenFromProperty(org.apache.jackrabbit.webdav.property.DavProperty)"> |
| <h3>getTokenFromProperty</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getTokenFromProperty</span><wbr><span class="parameters">(org.apache.jackrabbit.webdav.property.DavProperty<?> property)</span></div> |
| <div class="block">Returns the String value of the property, else null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>property</code> - Property who's string value is to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>String representation of the Property Value.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanupIdleConnections()"> |
| <h3>cleanupIdleConnections</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanupIdleConnections</span>()</div> |
| <div class="block">Cleans up unused idle connections.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="destroy()"> |
| <h3>destroy</h3> |
| <div class="member-signature"><span class="annotations">@PreDestroy |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">destroy</span>()</div> |
| <div class="block">Method which is called when the Context is destroyed.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012–2023 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
