How jeremybrooks/jinx works
Jinx is a Java client library for Flickr’s API. An application configures the Jinx client with credentials and an OAuth token, invokes a domain-specific API class, and receives a typed response (or a JinxException); the client handles signed HTTP requests and JSON conversion. README documents broad coverage including photo search, upload/replace, authentication, groups, places, tags, statistics and push. Most domain API implementations are unsampled, so their links to the client and Flickr are documented rather than asserted from inspected calls.
Main entry points: Jinx.java Jinx client · PhotosApi.java Photo API · OAuthApi.java OAuth API · PhotosUploadApi.java Photo upload
Components 21
Client core
- Jinx client
src/main/java/net/jeremybrooks/jinx/Jinx.java - API constants
src/main/java/net/jeremybrooks/jinx/JinxConstants.java - Jinx errors
src/main/java/net/jeremybrooks/jinx/JinxException.java - Request utilities
src/main/java/net/jeremybrooks/jinx/JinxUtils.java - Proxy settings
src/main/java/net/jeremybrooks/jinx/JinxProxy.java - Logging interface
src/main/java/net/jeremybrooks/jinx/logger/LogInterface.java
Authentication
- OAuth API
src/main/java/net/jeremybrooks/jinx/api/OAuthApi.java - OAuth token
src/main/java/net/jeremybrooks/jinx/OAuthAccessToken.java
Photo services
- Photo API
src/main/java/net/jeremybrooks/jinx/api/PhotosApi.java - Photo search options
src/main/java/net/jeremybrooks/jinx/response/photos/SearchParameters.java - Photo upload
src/main/java/net/jeremybrooks/jinx/api/PhotosUploadApi.java - Photo utilities
src/main/java/net/jeremybrooks/jinx/PhotoUtils.java
Other Flickr APIs
- Domain API modules
src/main/java/net/jeremybrooks/jinx/api - Preferences API
src/main/java/net/jeremybrooks/jinx/api/PrefsApi.java
Responses and utilities
- Response base
src/main/java/net/jeremybrooks/jinx/response/Response.java - Photo response model
src/main/java/net/jeremybrooks/jinx/response/photos/PhotoInfo.java - Person response model
src/main/java/net/jeremybrooks/jinx/response/people/Person.java - Photo context model
src/main/java/net/jeremybrooks/jinx/response/common/Context.java - Contacts response model
src/main/java/net/jeremybrooks/jinx/response/contacts/Contacts.java
Other components
- Java application
- Flickr API
Connections 30
- Java application → Jinx client: configures
- Java application → OAuth API: requests OAuth
- Java application → Photo API: calls
- Java application → Photo upload: uploads media
- Java application → Domain API modules: calls
- Jinx client → Flickr API: sends requests
src/main/java/net/jeremybrooks/jinx/Jinx.java - Jinx client → Request utilities: uses
src/main/java/net/jeremybrooks/jinx/Jinx.java - Jinx client → API constants: uses endpoints
src/main/java/net/jeremybrooks/jinx/Jinx.java - Jinx client → Jinx errors: throws
src/main/java/net/jeremybrooks/jinx/Jinx.java - Jinx client → Response base: parses into
src/main/java/net/jeremybrooks/jinx/Jinx.java - Jinx client → Logging interface: logs through
src/main/java/net/jeremybrooks/jinx/Jinx.java - Jinx client → OAuth token: uses credentials
src/main/java/net/jeremybrooks/jinx/Jinx.java - OAuth API → Jinx client: calls
src/main/java/net/jeremybrooks/jinx/api/OAuthApi.java - OAuth API → Flickr API: requests tokens
src/main/java/net/jeremybrooks/jinx/api/OAuthApi.java - OAuth API → OAuth token: exchanges token
src/main/java/net/jeremybrooks/jinx/api/OAuthApi.java - Photo API → Jinx client: uses client
src/main/java/net/jeremybrooks/jinx/api/PhotosApi.java - Photo API → Photo search options: accepts options
src/main/java/net/jeremybrooks/jinx/api/PhotosApi.java - Photo API → Photo response model: returns
src/main/java/net/jeremybrooks/jinx/api/PhotosApi.java - Photo upload → Jinx client: uses client
- Photo upload → Flickr API: uploads media
- Domain API modules → Jinx client: uses client
src/main/java/net/jeremybrooks/jinx/api/OAuthApi.java - Domain API modules → Flickr API: calls endpoints
- Preferences API → Jinx client: uses client
src/main/java/net/jeremybrooks/jinx/api/PrefsApi.java - Preferences API → Person response model: returns
src/main/java/net/jeremybrooks/jinx/api/PrefsApi.java - Photo response model → Response base: extends
src/main/java/net/jeremybrooks/jinx/response/photos/PhotoInfo.java - Person response model → Response base: extends
src/main/java/net/jeremybrooks/jinx/response/people/Person.java - Photo context model → Request utilities: converts values
src/main/java/net/jeremybrooks/jinx/response/common/Context.java - Contacts response model → Request utilities: converts values
src/main/java/net/jeremybrooks/jinx/response/contacts/Contacts.java - Photo API → Photo utilities: uses
- Jinx client → Proxy settings: supports proxy
src/main/java/net/jeremybrooks/jinx/Jinx.java